Skip to content
Proud to collaborate with Microsoft for Startups

identity.org-invitation.cancel ​

Cancel / revoke a pending organization invitation

Cancel a pending organization invitation.

Inputs:

  • invitation_uuid: Invitation UUID (required)
  • organization_uuid: Organization ID for tenant check (required)
  • actor: Cognito sub or user UUID of the actor (required)

Outputs (terminal state_data):

  • invitation_uuid
  • cancelled: bool
  • previous_status
  • reason: None on success, or short-circuit reason (already_cancelled, etc.)

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
invitation_uuiduuidYes——
organization_uuiduuidYes——
actorstringYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
invitation_uuiduuidYes——
cancelledbooleanYes——
previous_statusstringNo——
reasonstringNo——
cancelled_atdatetimeNo——
organization_uuiduuidNo——
actorstringNo——
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.org-invitation.cancel",
  "initial_data": {
    "invitation_uuid": "value",
    "organization_uuid": "value",
    "actor": "value"
  }
}