Get Supervisors Identity Providers
Returns information about an identity provider configured for a Supervisor.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}
Path Parameters
Path Parameters
string
supervisor
Required
identifier for the Supervisor for which the identity provider is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.
string
provider
Required
identifier for the identity provider that is being read. 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.
Response
Response
Response BodyResponse Body
200 OK returns
NamespaceManagementSupervisorsIdentityProvidersInfo
of type application/json
An {#link Info} representing the requested identity provider.
{
"additional_authorize_parameters": {
"key": "string"
},
"additional_scopes": [
"string"
],
"certificate_authority_data": "string",
"client_ID": "string",
"display_name": "string",
"groups_claim": "string",
"issuer_URL": "string",
"provider": "string",
"username_claim": "string"
}
string
issuer_URL
Required
The URL to the identity provider issuing tokens. The OIDC discovery URL will be derived from the issuer URL, according to RFC8414: https://issuerURL/.well-known/openid-configuration. This must use HTTPS as the scheme.
string
provider
Required
The immutable identifier of an identity provider generated when an identity provider is registered for a Supervisor. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.
string
client_ID
Required
The clientID is the OAuth 2.0 client ID registered in the upstream identity provider and used by the Supervisor.
string
display_name
Required
A name to be used for the given identity provider. This name will be displayed in the vCenter UI.
string
certificate_authority_data
Optional
The certificate authority data holds the trusted roots to be used to establish HTTPS connections with the identity provider. If unset, HTTPS connections with the upstream identity provider will rely on a default set of system trusted roots.
string
groups_claim
Optional
The claim from the upstream identity provider ID token or user info endpoint to inspect to obtain the groups for the given user. If unset, no groups will be used from the upstream identity provider.
map of
string
additional_authorize_parameters
Optional
Any additional parameters to be sent to the upstream identity provider during the authorize request in the OAuth2 authorization code flow. One use case is to pass in a default tenant ID if you have a multi-tenant identity provider. For instance, with VMware’s Cloud Services Platform, if your organization ID is ‘long-form-org-id’, the ‘orgLink’ parameter can be set to “/csp/gateway/am/api/orgs/long-form-org-id” to allow users logging in to leverage that organization. If unset, no additional parameters will be sent to the upstream identity provider.
array of
string
additional_scopes
Optional
Additional scopes to be requested in tokens issued by this identity provider. The ‘openid’ scope will always be requested. If unset, no additional scopes will be requested.
string
username_claim
Optional
The claim from the upstream identity provider ID token or user info endpoint to inspect to obtain the username for the given user. If unset, the upstream issuer URL will be concatenated with the ‘sub’ claim to generate the username to be used with Kubernetes.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user is missing the System.Read 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-GetSupervisorProviderIdentity -Supervisor "MySupervisor" -Provider "MyProvider"
cURL Command
curl -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: get
Availability
Added in 8.0.0.1
