SpecifyDocs

Api credential revoke

/v1/api-credentials/{credentialId}/revoke

Signed-in sessionLaunch key api.credentialsOperation api_credential_revoke

Account admins will create, rotate and revoke credentials for the suite API.

Path parameters

credentialIdstringRequired

Body

idempotencyKeystringRequired
expectedVersionnumberRequired

Returns

status"active" | "revoked"Required
scopesstring[]Required
idstringRequired
actorIdstringRequired
versionnumberRequired
createdAtnumberRequired
expiresAtnumberRequired
serviceTenancyIdstringRequired
environmentstringRequired
prefixstringRequired
audiencestringRequired
revokedAtnumber

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.