Developer Documentation

ProvidersOidcSummary

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

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

required client_id string

Client identifier to connect to the provider

optional discovery_endpoint string

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

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 token_endpoint string

Token endpoint of the provider

Feedback

Was this page helpful?