Get OIDC User Info
DescriptionDisplay the content of the given access token if the token is valid. Also includes the group_ids and group_names if the client is registered with group_id, group_names scopes. If the token is invalid or expired, an error will be returned. If group_ids and group_names are both requested, they will be in the same order in both the claims. If the token was obtained using an API token, the groups information will be available only if the openid scope was selected.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Anonymous | ✔️ | ✔️ |
Request
URLURL
Header Parameters
Header Parameters
Access token in ‘Bearer’ authentication format i.e. ‘Bearer XXX’ where XXX is the content of an access token.
Authentication
Response
Response BodyResponse Body
200 OK
{
"acct": "string",
"context": "string",
"context_name": "string",
"domain": "string",
"email": "string",
"email_verified": false,
"family_name": "string",
"given_name": "string",
"group_ids": [
"string"
],
"group_names": [
"string"
],
"sub": "string",
"username": "string"
}
The identifier of the user, configured to log in to the Identity provider. The acct claim can be a combination of the user’s username and domain in URLEncoded(username)@domain format or the user’s email or the UPN of the user.
The context identifier in which the token was issued.
The context name (equals to CSP organization ID) in which the token was issued.
The identity provider (IdP) domain of the user.
The email address of the user.
True if the user’s e-mail address has been verified.
The family name of the user.
The ‘given’ name of the user.
Group ids the user belongs to. Property will be returned only if the client registered with ‘group_ids’ scope.
Group names the user belongs to. Property will be returned only if the client registered with ‘group_names’ scope.
The user on behalf of which the token was issued.
The username of the user.
Errors
Authorization header must be specified | Invalid authorization header. Missing “Bearer” prefix | Invalid bearer token. Missing valid token.
The requested resource could not be found
The user has sent too many requests
An unexpected error has occurred while processing the request
