Get Providers
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Retrieve detailed information of the specified identity provider. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.
Request
URLURL
https://{api_host}/rest/vcenter/identity/providers/{provider}
Parameters
Parameters
string
provider
Required
the identifier of the provider
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, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
IdentityProvidersGetResponseBody
of type application/json
Detailed information of the specified identity provider.
{
"value": {
"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": "key1",
"value": "string"
}
],
"config_tag": "enum",
"domain_names": [
"string"
],
"groups_claim": "string",
"idm_endpoints": [
"string"
],
"idm_protocol": "enum",
"is_default": false,
"name": "string",
"oauth2": {
"auth_endpoint": "string",
"auth_query_params": [
{
"key": "key1",
"value": "string"
}
],
"authentication_method": "enum",
"client_id": "string",
"client_secret": "string",
"issuer": "string",
"public_key_uri": "string",
"token_endpoint": "string"
},
"oidc": {
"auth_endpoint": "string",
"auth_query_params": [
{
"key": "key1",
"value": "string"
}
],
"authentication_method": "enum",
"client_id": "string",
"client_secret": "string",
"discovery_endpoint": "string",
"issuer": "string",
"logout_endpoint": "string",
"public_key_uri": "string",
"token_endpoint": "string"
},
"org_ids": [
"string"
],
"upn_claim": "string"
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/identity/providers/{provider}
Errors
404
com.vmware.vapi.std.errors.not_found : if no provider found with the given provider identifier.
Providers Operations
get
post
get
patch
delete
