get https://{application_vanity_domain}/api/v1/oauth2/userinfo
OIDC Compliant
This endpoint is compliant with the UserInfo Endpoint specification.
This endpoint can be used to retrieve claims corresponding to the user associated to the access token passed in the Authorization
header. The claims that are returned in the response are dictated in part by the scopes that were provided when calling the Authorize Endpoint. Please see the below table to determine which scopes map to which claims.
Scope | Claims |
---|---|
profile | name , given_name , family_name , middle_name , nickname , preferred_username , picture , gender , birthdate , zoneinfo , locale , updated_at |
email , email_verified | |
phone | phone_number , phone_number_verified |
roles | roles |
In addition to the above claims, the following claims all always returned, regardless of the specified scopes: sub
, tnt_id
, app_id
, idp_name
.
Furthermore, if custom claims have been configured for the UserInfo response, they will always be returned regardless of the specified scopes.