Update Providers Deprecated
Update a vCenter Server identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
Request
URLURL
https://{api_host}/rest/vcenter/identity/providers/{provider}
Path Parameters
Path Parameters
string
provider
Required
the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.
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"
Request Body
Request Body
IdentityProvidersUpdateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"config_tag": "Oauth2"
}
}
spec
Required
the UpdateSpec contains the information used to update the provider
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if invalid arguments are provided in updateSpec.
404
com.vmware.vapi.std.errors.not_found : if no provider found with the given provider identifier.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"active_directory_over_ldap":{"cert_chain":{"cert_chain":["string"]},"groups_base_dn":"string","password":"string","server_endpoints":["string"],"user_name":"string","users_base_dn":"string"},"auth_query_params":{"key":"string"},"config_tag":"Oauth2","domain_names":["string"],"groups_claim":"string","idm_endpoints":["string"],"idm_protocol":"REST","make_default":false,"name":"string","oauth2":{"auth_endpoint":"string","auth_query_params":{"key":"string"},"authentication_method":"CLIENT_SECRET_BASIC","client_id":"string","client_secret":"string","issuer":"string","public_key_uri":"string","token_endpoint":"string"},"oidc":{"client_id":"string","client_secret":"string","discovery_endpoint":"string"},"org_ids":["string"],"reset_groups_claim":false,"reset_upn_claim":false,"upn_claim":"string"}}' https://{api_host}/rest/vcenter/identity/providers/{provider}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: patch
x-vmw-doc-new-path: /api/vcenter/identity/providers/{provider}
x-vmw-doc-operation: update
Availability
Added in 7.0.0
On This Page
Providers Operations
get
post
get
patch
delete
