Vcenter Identity Providers delete

Vcenter Identity Providers delete

Delete a vCenter Server identity provider.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIdentityProviders.Manage.
Request
URI
DELETE
https://{api_host}/api/vcenter/identity/providers/{provider}
COPY
Path Parameters
string
provider
Required

the identifier of the provider to delete

The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.


Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

403

if authorization is not given to caller.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0
{
    "messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ],
    "data": {},
    "error_type": "string"
}

404

if no provider found with the given provider identifier.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/vcenter/identity/providers/{provider}