IAM API ReferenceAPI Token

Rotate API token

Rotate an API token. Creates a new API token and invalidates the one you specify. Any workflows using the previous value stop working.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired
The ID of the Organization where you want to rotate an API token.
tokenIdstringRequired
The token to rotate

Response

OK
createdAtstringformat: "date-time"

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.
startAtstringformat: "date-time"

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:
updatedAtstringformat: "date-time"

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

createdByobject or null
endAtstring or nullformat: "date-time"

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

expiryPeriodInDaysinteger or null
The expiry period of the API token in days.
lastUsedAtstring or nullformat: "date-time"

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

roleslist of objects or null
The roles of the API token.
tokenstring or null
The value of the API token.
updatedByobject or null

Errors