Developer Documentation

ProvidersOidcInfo

The Providers.OidcInfo structure contains information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so Providers.OidcInfo contains additional discovered OAuth2 metadata.


Properties

Required Property Name Type Description
required auth_endpoint string

Authentication/authorization endpoint of the provider

required auth_query_params map of string

key/value pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details: - If the value contains only one string, then the key is added with “k=v”. - If the value is an empty list, then the key is added without a “=v”. - If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.

required authentication_method ProvidersOauth2AuthenticationMethod Enum

Authentication method used by the provider

required claim_map map[string]map[string][]string

The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key “perms” is supported. The key “perms” is used for mapping the “perms” claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value.

required client_id string

Client identifier to connect to the provider

required client_secret string

The secret shared between the client and the provider

required discovery_endpoint string

Endpoint to retrieve the provider metadata

required issuer string

The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token

optional logout_endpoint string

The endpoint to use for terminating the user’s session at the identity provider. This value is automatically derived from the metadata information provided by the OIDC discovery endpoint. This field is optional because it was added in a newer version than its parent node.

required public_key_uri string

Endpoint to retrieve the provider public key for validation

required token_endpoint string

Token endpoint of the provider

Feedback

Was this page helpful?