Skip to content
Proud to collaborate with Microsoft for Startups

identity.api-token.revoke ​

Revoke (hard-delete) an API token for the current user

Revoke (hard-delete) one of the current user's API tokens.

Inputs:

  • token_uuid: public uuid of the token to revoke (required)
  • actor: Cognito sub or user UUID (required)

Outputs (terminal state_data):

  • token_uuid
  • revoked: bool
  • reason: "revoked" or "already_revoked"

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
token_uuidstringYes——
actorstringYes——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
token_uuidstringYes——
revokedbooleanYes——
reasonstringNo——
actorstringNo——
organization_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "identity.api-token.revoke",
  "initial_data": {
    "token_uuid": "value",
    "actor": "value"
  }
}