tokens

POST /tokens/{id}/regenerate

Changed on

Creates a new API token with the existing token's capabilities, or with those in newToken, and returns its secret value. The existing token keeps working until existingTokenExpiresAt; set it to the current time to revoke it immediately.

Request

Path parameters

idstring required

Request body

existingTokenExpiresAtstring date-time required

Expiration date of the existing token (ISO 8601 format)

newTokenExpiresAtstring date-time nullable

Expiration date of the new token (ISO 8601 format)

Response

New API token, including its secret token value.

apiLastUsedstring date-time nullable

When the token was last used on an API other than ingest

auditIdentitystring

Audit identity of the token

datasetCapabilitiesDatasetCapabilities required
descriptionstring

Description of the token

expiresAtstring date-time nullable

Expiration date of the token (ISO 8601 format)

idstring required

ID of the token

ingestLastUsedstring date-time nullable

When the token was last used to ingest

namestring required

Name of the token

samlAuthenticatedboolean
viewCapabilitiesViewCapabilities
tokenstring

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • warning

      removed the request property ///

    • warning

      removed the request property //

    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      added the new optional request property //

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status