Get provider's metadata

get https://{tenanturl}/oauth2/.well-known/openid-configuration

Use this API to get the OIDC provider's metadata.

Responses

Response body

object

issuer

string

required

The OpenID provider issuer identifier.

authorization_endpoint

string

required

The URL of the OpenID provider authorization endpoint.

token_endpoint

string

The URL of the OpenID provider token endpoint.

introspection_endpoint

string

The URL of the OpenID provider introspect endpoint.

userinfo_endpoint

string

The URL of the OpenID provider userinfo endpoint.

revocation_endpoint

string

The URL of the OpenID provider revoke endpoint.

device_authorization_endpoint

string

The URL of the OpenID provider device authorization endpoint.

user_authorization_endpoint

string

The URL of the OpenID provider user authorization endpoint.

pushed_authorization_request_endpoint

string

The URL of the OpenID provider pushed authorization request endpoint.

registration_endpoint

string

The URL of the OpenID provider dynamic client registration endpoint.

jwks_uri

string

The URL of the OpenID provider JSON Web Key Set endpoint.

response_types_supported

array of strings

The JSON array that contains a list of the response_type values that this OpenID provider supports.

response_types_supported

response_modes_supported

array of strings

The JSON array that contains a list of the response_mode values that this OpenID provider supports.

response_modes_supported

grant_types_supported

array of strings

The JSON array that contains a list of the grant_type values that this OpenID provider supports.

grant_types_supported

token_endpoint_auth_methods_supported

array of strings

The JSON array that contains a list of client authentication methods that are supported by this token endpoint.

token_endpoint_auth_methods_supported

id_token_signing_alg_values_supported

array of strings

The JSON array that contains a list of the JSON Web Signature (JWS) signing algorithms that are supported by the OpenID provider for the ID token to encode the claims in a JSON Web Token.

id_token_signing_alg_values_supported

id_token_encryption_alg_values_supported

array of strings

The JSON array that contains a list of the JSON Web Encryption (JWE) algorithms that are supported by the OpenID provider for the ID token to encode the claims in a JSON Web Token.

id_token_encryption_alg_values_supported

id_token_encryption_enc_values_supported

array of strings

The JSON array that contains a list of the JSON Web Encryption (JWE) encryption algorithms that are supported by the OpenID provider for the ID token to encode the claims in a JSON Web Token.

id_token_encryption_enc_values_supported

userinfo_signing_alg_values_supported

array of strings

The JSON array that contains a list of the JSON Web Signature (JWS) signing algorithms that are supported by the UserInfo endpoint to encode the claims in a JSON Web Token.

userinfo_signing_alg_values_supported

userinfo_encryption_alg_values_supported

array of strings

The JSON array that contains a list of the JSON Web Encryption (JWE) algorithms that are supported by the UserInfo endpoint to encode the claims in a JSON Web Token.

userinfo_encryption_alg_values_supported

userinfo_encryption_enc_values_supported

array of strings

The JSON array that contains a list of the JSON Web Encryption (JWE) encryption algorithms that are supported by the UserInfo endpoint to encode the claims in a JSON Web Token.

userinfo_encryption_enc_values_supported

request_object_signing_alg_values_supported

array of strings

The JSON array that contains a list of the JSON Web Signature (JWS) signing algorithms that are supported by the OpenID provider for request objects.

request_object_signing_alg_values_supported

request_object_encryption_alg_values_supported

array of strings

The JSON array that contains a list of the JSON Web Encryption (JWE) algorithms that are supported by the OpenID provider for request objects.

request_object_encryption_alg_values_supported

request_object_encryption_enc_values_supported

array of strings

The JSON array that contains a list of the JSON Web Encryption (JWE) encryption algorithms that are supported by the OpenID provider for request objects.

request_object_encryption_enc_values_supported

subject_types_supported

array of strings

The JSON array containing a list of the Subject Identifier types that this OP supports.

subject_types_supported

scopes_supported

array of strings

The JSON array that contains a list of the scope values that this server supports.

scopes_supported

claims_supported

array of strings

The JSON array that contains a list of the names of the claims that the OpenID provider might be able to supply values for.

claims_supported

claim_types_supported

array of strings

The JSON array that contains a list of the claim types that the OpenID provider supports.

claim_types_supported

claims_parameter_supported

boolean

A Boolean value that specifies whether the OpenID provider supports the use the claims parameter.

request_parameter_supported

boolean

A Boolean value that specifies whether the OpenID provider supports the use the request parameter.

request_uri_parameter_supported

boolean

A Boolean value that specifies whether the OpenID provider supports the use of the request_uri parameter.

require_request_uri_registration

boolean

A Boolean value that specifies whether the OpenID provider requires that all request_uri values be pre-registered before use. These values are registered by using the request_uris registration parameter.

tls_client_certificate_bound_access_tokens

boolean

mtls_endpoint_aliases

object

Has additional fields

Headers

object

Content-Type

string

X-Correlation-Id

string

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/oauth2/.well-known/openid-configuration \
3
     --header 'accept: application/json'

Choose an example:

application/json

text/plain

200The metadata was returned

404The resource was not found.

500An internal server error occurred.