DocumentationReferenceAPI ReferenceScoped Access Keys

Rotate Access Key

View as Markdown

Path parameters

jtistringRequiredformat: "^ak_[0-9a-f]{32}$"
Stable JWT ID of the Scoped Access Key for the lifecycle operation.

Request

This endpoint expects an object.
grace_period_secondsinteger or nullOptional>=1

Grace period in seconds for the rotated-out key. Omit to use auth.access_keys.rotation_grace_period_seconds. Subject to auth.access_keys.max_rotation_grace_period_seconds.

Response

Successful Response
new_keyobject
Newly minted successor Scoped Access Key. Its raw token is returned only once.
previous_jtistring
Stable JWT ID of the Scoped Access Key that was rotated out.
previous_statusenum

Effective status of the rotated-out key immediately after this request. Normally ROTATING, but may already read as REVOKED or EXPIRED if reconciling this request’s outcome was itself delayed past the grace deadline or a concurrent revoke.

grace_period_secondsinteger

Seconds the rotated-out key remains usable before it is treated as revoked.

grace_period_expires_atdatetime or nullOptional

Timestamp when the rotated-out key’s grace period expires.

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
501
Not Implemented Error