IdentityProvidersOauth2Summary

The Providers.Oauth2Summary structure contains commonly used information about an OAuth2 identity provider.


Properties

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