IAM API ReferenceAPI Token

Update an API token

Update the name and description of an API token.

Path parameters

organizationIdstringRequired

The ID of the Organization where you want to update an API token.

tokenIdstringRequired

The API token you want to update.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired>=1 character<=256 characters

The name of the API token.

descriptionstringOptional<=500 characters

The description of the API token.

Response

OK

createdAtdatetime

The time when the API token was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

descriptionstring

The description of the API token.

idstring

The API token’s ID.

namestring

The name of the API token.

shortTokenstring

The short value of the API token.

startAtdatetime

The time when the API token will become valid in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

typeenum

The type of the API token.

Allowed values:
updatedAtdatetime

The time when the API token was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobjectOptional
endAtdatetimeOptional

The time when the API token expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

expiryPeriodInDaysintegerOptional

The expiry period of the API token in days.

lastUsedAtdatetimeOptional

The time when the API token was last used in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

roleslist of objectsOptional

The roles of the API token.

tokenstringOptional

The value of the API token.

updatedByobjectOptional

Errors