Delete Supervisors Identity Providers
DescriptionRemove an identity provider configured with a given Supervisor. This will result in users no longer being able to log in to either the Supervisor or any of its workload clusters with that identity provider.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}
Path Parameters
Path Parameters
string
supervisor
Required
the identifier of the Supervisor which is associated with the identity provider being removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
string
provider
Required
the identifier for the identity provider that is to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user is missing the Namespaces.Manage privilege on the Supervisor.
404
com.vmware.vapi.std.errors.not_found : if the given identity provider or Supervisor cannot be found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DeleteSupervisorProviderIdentity -Supervisor "MySupervisor" -Provider "MyProvider"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 8.0.0.1
