Skip to main content
Update an API key

Authorizations

Authorization
string
header
required

Clerk session with an active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 100
level
enum<string>
Available options:
read,
write,
admin
access
object

Response

Updated active key. Migrated keys retain their original organization restriction.

id
string<uuid>
required
name
string
required
level
enum<string>
required
Available options:
read,
write,
admin
access
object
required
status
enum<string>
required
Available options:
active,
suspended,
revoked
original_organization_id
string | null
required
Required string length: 1 - 255
organizations
object[]
required
created_at
string<date-time>
required
revoked_at
string<date-time> | null
required
disabled_at
string<date-time> | null
required