1. Types
  2. vcenter
  3. identity
  4. providers

vcenter identity providers: oidc summary

The oidc_summary structure contains commonly used information about an OIDC identity provider. OIDC is a discovery protocol for OAuth2 configuration metadata, so oidc_summary contains discovered OAuth2 metadata. This structure was added in vSphere API 7.0.0.0.

Representation:

{
    "authentication_header" : "string",
    "auth_endpoint" : "http://myurl.com",
    "logout_endpoint" : "http://myurl.com",
    "auth_query_params" : {
        "<string>" : [
            "string",
            "string"
        ]
    },
    "discovery_endpoint" : "http://myurl.com",
    "client_id" : "string",
    "token_endpoint" : "http://myurl.com"
}
{
    "authentication_header" : "string",
    "auth_endpoint" : "http://myurl.com",
    "logout_endpoint" : "http://myurl.com",
    "auth_query_params" : [
        {
            "value" : [
                "string",
                "string"
            ],
            "key" : "string"
        }
    ],
    "discovery_endpoint" : "http://myurl.com",
    "client_id" : "string",
    "token_endpoint" : "http://myurl.com"
}

Attributes:

Name Type Description
Required
-.auth_endpoint URI Authentication/authorization endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
-.token_endpoint URI Token endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
-.client_id string Client identifier to connect to the provider. This attribute was added in vSphere API 7.0.0.0.
-.authentication_header string The authentication data used as part of request header to acquire or refresh an OAuth2 token. The data format depends on the authentication method used. Example of basic authentication format: Authorization: Basic [base64Encode(clientId + ":" + secret)]. This attribute was added in vSphere API 7.0.0.0.
-.auth_query_params object

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.
. This attribute was added in vSphere API 7.0.0.0.

Object with element values of type string[].
-.auth_query_params.* string[]
Optional
-.discovery_endpoint URI Endpoint to retrieve the provider metadata. This attribute was added in vSphere API 7.0.0.0.

Optional. This field is optional because it was added in a newer version than its parent node.
-.logout_endpoint URI 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 attribute was added in vSphere API 7.0.0.0.

Optional. This field is optional because it was added in a newer version than its parent node.