Skip to main content
POST
Create Key

Authorizations

Authorization
string
header
required

A token from the identity provider your deployment federates with. It identifies a person; their roles in the workspace decide what they may do.

Body

application/json
name
string
required
Required string length: 1 - 120
environment
string
default:prod
Pattern: ^(dev|staging|prod|live|test)$
expires_in_days
integer | null
Required range: 1 <= x <= 3650
scope_source
string
default:asserted
Pattern: ^(asserted|observed)$

Response

Successful Response

A newly minted key, and the one time its secret is visible.

id
string
required
name
string
required
environment
string
required
scope_source
string
required
display
string
required
created_by
string
required
created_at
string<date-time>
required
active
boolean
required
never_used
boolean
required
dormant
boolean
required
key
string
required
warning
string
required
expires_at
string<date-time> | null
last_used_at
string<date-time> | null
revoked_at
string<date-time> | null
revocation_reason
string | null