Expand Id Token

Expand Id Token
Expand ID Token

Display the content of the given id token with expanded claims if the token is valid.
If the token is invalid or expired, an error will be returned.
Note: Enter the Access Token in Bearer format i.e. 'Bearer XXX' where XXX is the content of a VIDB access token using the Authorize Button.

Request
URI
GET
https://{api_host}/acs/t/{tenant}/expand-id-token
COPY
Path Parameters
string
tenant
Required

The VMware Identity Services tenant ID

tenant example
my-tenant
Query Parameters
string
format
Optional
Constraints: default: raw

Specifies the format for the returned expanded token.

  • raw (default) - Returns the data as a raw JSON object.
  • jwt - Returns the data as a signed JSON Web Token.
format example
raw
Possible values are : raw, jwt,
Authentication
This operation uses the following authentication methods.
Responses
200

The token expand returned successfully.

Returns expandIdToken_200_response of type(s) application/json
OneOf
This class returns at least one of the following:
{
    "nonce": "string",
    "email": "string",
    "customClaims": {
        "customClaims": {}
    },
    "exp": 0,
    "iat": 0,
    "sub": "string",
    "jti": "string",
    "iss": "string",
    "aud": [
        "string"
    ],
    "auth_time": 0,
    "acr": "string",
    "azp": "string",
    "at_hash": "string",
    "c_hash": "string",
    "name": "string",
    "given_name": "string",
    "family_name": "string",
    "email_verified": false,
    "updated_at": 0,
    "group_names": [
        "string"
    ],
    "group_ids": [
        "string"
    ],
    "ovl": "string",
    "ovc": [
        "string"
    ],
    "acct": "string",
    "user_name": "string",
    "oid": "string",
    "roles": [
        {
            "name": "admin",
            "resources": [
                "string"
            ],
            "_links": {
                "self": {
                    "href": "https://example.com/path-to-self"
                }
            },
            "display_name": "Administrator",
            "membership_type": [
                "DIRECT",
                "GROUP"
            ],
            "group_ids": [
                "groupId1",
                "groupId2"
            ],
            "sub_roles": [
                {
                    "type": "nsx",
                    "names": [
                        {
                            "name": "moderator",
                            "display_name": "Moderator"
                        }
                    ],
                    "_links": {
                        "self": {
                            "href": "https://example.com/path-to-self"
                        }
                    }
                }
            ],
            "expires_at": 1700000000000
        }
    ]
}

400

The token is invalid or expired.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/acs/t/{tenant}/expand-id-token
On This Page
Authentication Operations
GET
Authorize
GET
Expand Access Token
GET
Expand Id Token
POST
Get Access Token
POST
Revoke