Token

Token
Token

Specifies a user, the user's organization, and the user assigned token that can be used to access proxies as well as the expiration timestamp of the token (in UTC). Parameters cannot be edited once a token is created.

JSON Example undefined undefined 
{
    "id": "string",
    "name": "string",
    "token": "string",
    "expirationTimeUtc": "string",
    "requireRotation": false,
    "tokenRotation": "string",
    "owner": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "type": "string"
}
string
id
Required

ID of this token. Sorting on this field is not supported.

string
name
Required

Name of the token

string
token
Optional

User specific token that can be used to access proxies. Sorting on this field is not supported.

string As date-time As date-time
expirationTimeUtc
Optional

Time stamp representing when the token will expire (in UTC).

boolean
requireRotation
Optional

Whether or not token rotation is required on every use of the refresh token for this token. This only applies for refresh tokens, and will be null otherwise.

string
tokenRotation
Optional

Defines the token rotation behavior. ALWAYS: Tokens are rotated automatically when requireRotation=true. NEVER: Tokens are never rotated (requireRotation=false). ONCE_ON_NEXT_LOGIN: Token rotates on the next login, then resets to NEVER and sets requireRotation=false. NONE: Not applicable.

EntityReference
owner
Optional

Entity reference used to describe VCD entities

EntityReference
org
Optional

Entity reference used to describe VCD entities

string
type
Optional

Type of the token. Can be of type PROXY or EXTENSION

Parameter To
Returned By