Get Access Token Info

Get Access Token Info

Use this API instead:

  • /scim/v2/Users

The user information includes all user related fields (which are also part of the associated user ID token). Group ids and names are included.The API diverges from the CSP API on 1) 'email_verified' field which is currently not provided by this API and 2) the 'sub' field which contains user ID only in contrast with CSP thatcontains ':'.

Access Policy

Role Access
Anonymous ✔️
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/csp/gateway/am/api/userinfo
COPY
Header Parameters
string
Authorization
Required

Authorization


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UserTokenResponse of type(s) */*
{
    "username": "string",
    "email": "string",
    "domain": "string",
    "acct": "string",
    "context": "string",
    "sub": "string",
    "given_name": "string",
    "family_name": "string",
    "email_verified": false,
    "group_names": [
        "string"
    ],
    "group_ids": [
        "string"
    ],
    "context_name": "string"
}
string
username
Optional

The user's username.

string
email
Optional

The user's email.

string
domain
Optional

The domain the user belongs to.

string
acct
Optional

The user's account identifier, 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.

string
context
Optional

The context in which the token was issued.

string
sub
Optional

The user on behalf of which the token was issued.

string
given_name
Optional

The user's given name.

string
family_name
Optional

The user's family name.

boolean
email_verified
Optional

True if the user's e-mail address has been verified; otherwise false.

array of string
group_names
Optional

Names of the groups the user belongs to.

array of string
group_ids
Optional

Identifiers of the groups the user belongs to.

string
context_name
Optional

The context name in which the token was issued.


401

The user is not authorized to use the API.

Returns UserTokenResponse of type(s) */*
"UserTokenResponse Object"
string
username
Optional

The user's username.

string
email
Optional

The user's email.

string
domain
Optional

The domain the user belongs to.

string
acct
Optional

The user's account identifier, 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.

string
context
Optional

The context in which the token was issued.

string
sub
Optional

The user on behalf of which the token was issued.

string
given_name
Optional

The user's given name.

string
family_name
Optional

The user's family name.

boolean
email_verified
Optional

True if the user's e-mail address has been verified; otherwise false.

array of string
group_names
Optional

Names of the groups the user belongs to.

array of string
group_ids
Optional

Identifiers of the groups the user belongs to.

string
context_name
Optional

The context name in which the token was issued.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/userinfo