DocumentationReferenceAPI ReferenceScoped Access Keys

Create Access Key

View as Markdown

Request

This endpoint expects an object.
namestring or nullOptional1-128 characters

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

descriptionstring or nullOptional<=1024 characters

Optional human-readable description of the Scoped Access Key.

expires_in_secondsinteger or nullOptional>=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.

service_account_idstring or nullOptionalformat: "^[a-zA-Z0-9][a-zA-Z0-9._+/-]*$"1-240 characters

Optional non-human service account to bind the key to. Service-bound keys can only be created by a PlatformAdmin and authenticate as service-account:<id>.

Response

Successful Response
jtistring
Stable JWT ID for this Scoped Access Key.
principalstring
Principal ID stamped into the token.
statusenum
issuerstring
Issuer stamped into the Scoped Access Key JWT.
audienceslist of strings
Audiences accepted for the Scoped Access Key JWT.
created_atdatetime
tokenstring
token_type"Bearer"
namestring or nullOptional

Optional human-readable Scoped Access Key label.

descriptionstring or nullOptional

Human-readable description of the Scoped Access Key.

entity_typeenumOptionalDefaults to USER

Whether the key is bound to a user or a non-human service account.

expires_atdatetime or nullOptional
grace_period_expires_atdatetime or nullOptional

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

last_used_atdatetime or nullOptional
Timestamp of the most recent successful authentication with this Scoped Access Key.

Errors

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