Update an API token
Update the name and description of an API token.
Path parameters
organizationId
The ID of the Organization where you want to update an API token.
tokenId
The API token you want to update.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
name
The name of the API token.
description
The description of the API token.
Response
OK
createdAt
The time when the API token was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
.
description
The description of the API token.
id
The API token's ID.
name
The name of the API token.
shortToken
The short value of the API token.
startAt
The time when the API token will become valid in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
.
type
The type of the API token.
Allowed values:
updatedAt
The time when the API token was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
.
createdBy
endAt
The time when the API token expires in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
.
expiryPeriodInDays
The expiry period of the API token in days.
lastUsedAt
The time when the API token was last used in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ
.
roles
The roles of the API token.
token
The value of the API token.
updatedBy