Create Access Key

View as Markdown

Request

This endpoint expects an object.
namestringOptional1-128 characters

Optional human-readable Scoped Access Key label. The token jti remains the stable identifier.

expires_in_secondsintegerOptional>=1

Scoped Access Key lifetime in seconds. Omit to use auth.access_keys.default_expires_in_seconds. Send explicit null to request a non-time-delimited key, which requires auth.access_keys.max_expires_in_seconds to be disabled.

Response

Successful Response
jtistring
Stable JWT ID for this Scoped Access Key.
principalstring
Principal ID stamped into the token.
created_atdatetime
tokenstring
token_type"Bearer"
namestringOptional

Optional human-readable Scoped Access Key label.

expires_atdatetimeOptional

Errors

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