Owner key management
Generate or rotate the API key
Issue a new key and return its full value once. If a key is already active, it stops working immediately.
POST
View examples/api/v1/organization/api-key/rotateAuthentication
Authorization required header
An access token from normal sign-in as the organization owner.
Set up accessParameters
This operation takes no path or query parameters.
This operation takes no request body.
Responses
200Successful Response
application/jsonOrganizationAPIKeyIssued
configuredbooleanrequiredprefixstring | nullrequiredissued_atstring · date-time | nullrequiredapi_keystringrequired
401Missing, invalid, expired, or revoked authentication credentials
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null
WWW-Authenticate · Authentication challenge for the required credential scheme
403The authenticated account is not permitted to perform this operation
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null
413Image or total request body exceeds its configured byte limit
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null
500Unexpected server error; internal details are withheld
application/jsonApiErrorOut
detailstring | array of ValidationIssueOut | objectrequiredShow fields
locarray of string | integerrequiredmsgstringrequiredtypestringrequired
codestring | null