Authentication
Revoke an API key
Revokes an API key, so requests made with it are refused from that moment. The person and their other keys are not affected. Set cascade to true to also revoke every key this key issued, recursively.
Requires: desk.admin scope, workspace owner or admin.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Path Parameters
id*string
The api key's id (a UUID).
Query Parameters
cascade?boolean
true to also revoke every key this key issued, recursively.
Response
OK
Example
{ "revoked": 1}FieldTypeDescription
revokedrequiredintegercurl -X DELETE "https://api.sautidesk.com/v1/desk/api-keys/string"