Create API key

POST

/user/api-keys

Create a new API key. The plaintext key is returned only once in this response.

Authorizations

• bearerAuth

Request Body ^required

object

name

required

string

>= 1 characters <= 200 characters

expiresAt

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

Responses

200

Created API key with one-time plaintext value

object

apiKey

required

object

id

required

string

accountId

required

string

name

required

string

prefix

required

string

last4

required

string

scopes

required

Array<string>

lastUsedAt

required

Any of:

string

string

null

null

expiresAt

required

Any of:

string

string

null

null

revokedAt

required

Any of:

string

string

null

null

createdAt

required

string

updatedAt

required

string

plaintextKey

required

string

400

Invalid request

401

Unauthorized

403

Forbidden