Get Oidc User Info Using GET
Display 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 | ✔️ | ✔️ |
Access token in 'Bearer' authentication format i.e. 'Bearer XXX' where XXX is the content of an access token.
OK
{
"family_name": "string",
"context": "string",
"email": "string",
"sub": "string",
"email_verified": false,
"group_names": [
"string"
],
"username": "string",
"group_ids": [
"string"
],
"acct": "string",
"context_name": "string",
"given_name": "string",
"domain": "string"
}The family name of the user.
The context identifier in which the token was issued.
The email address of the user.
The user on behalf of which the token was issued.
True if the user's e-mail address has been verified.
Group names the user belongs to. Property will be returned only if the client registered with 'group_names' scope.
The username of the user.
Group ids the user belongs to. Property will be returned only if the client registered with 'group_ids' scope.
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 name (equals to CSP organization ID) in which the token was issued.
The 'given' name of the user.
The identity provider (IdP) domain of the user.
Authorization header must be specified | Invalid authorization header. Missing "Bearer" prefix | Invalid bearer token. Missing valid token.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The requested resource could not be found
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/userinfo