IdentityProvidersOidcSummary

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


Properties

string as uri
auth_endpoint Required

Authentication/authorization endpoint of the provider


map of string
auth_query_params Required

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.


string
authentication_header Required

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)]


string
client_id Required

Client identifier to connect to the provider


string as uri
discovery_endpoint Optional

Endpoint to retrieve the provider metadata This field is optional because it was added in a newer version than its parent node.


string as uri
logout_endpoint Optional

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.


string as uri
token_endpoint Required

Token endpoint of the provider

JSON Example

{
    "auth_endpoint": "string",
    "auth_query_params": {
        "key": "string"
    },
    "authentication_header": "string",
    "client_id": "string",
    "token_endpoint": "string"
}

Feedback

Was this page helpful?