Update Token

Update Token

Update a token

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/tokens/{id}
COPY
Path Parameters
string
id
Required

Token ID URN

string
id
Required

Token ID URN

Request Body
Token of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "token": "string",
    "expirationTimeUtc": "string",
    "requireRotation": false,
    "owner": {
        "name": "string",
        "id": "string"
    },
    "username": "string",
    "userId": "string",
    "orgName": "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.

EntityReference
owner
Optional

Entity reference used to describe VCD entities

string
username
Optional

Name of the user that this token is assigned to.

string
userId
Optional

ID of the user that this token is assigned to. Sorting on this field is not supported. Can not be updated.

string
orgName
Optional

Name of the organization that the assigned user belongs to. Sorting and filtering on this field is not supported.

EntityReference
org
Optional

Entity reference used to describe VCD entities

string
type
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Token of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "token": "string",
    "expirationTimeUtc": "string",
    "requireRotation": false,
    "owner": {
        "name": "string",
        "id": "string"
    },
    "username": "string",
    "userId": "string",
    "orgName": "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.

EntityReference
owner
Optional

Entity reference used to describe VCD entities

string
username
Optional

Name of the user that this token is assigned to.

string
userId
Optional

ID of the user that this token is assigned to. Sorting on this field is not supported. Can not be updated.

string
orgName
Optional

Name of the organization that the assigned user belongs to. Sorting and filtering on this field is not supported.

EntityReference
org
Optional

Entity reference used to describe VCD entities

string
type
Optional

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


Availability
Added in 39.0
On This Page
Token Operations
POST
Create Token
DELETE
Delete Token
GET
Get Token
GET
Get Tokens
PUT
Update Token