Skip to content
Proud to collaborate with Microsoft for Startups

identity.org-invitation.accept ​

Accept an organization invitation by token

Accept an organization invitation by one-time token.

Inputs:

  • token: Invitation token (required)
  • actor: Cognito sub or user UUID of the accepting user (required)

Outputs (terminal state_data):

  • accepted: bool
  • reason: str or None (why accepted=False, or "already_member" for idempotent)
  • organization_uuid: str or None
  • membership_uuid: str or None
  • role: str or None

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
tokenstringYes—One-time invitation bearer token authorizing membership creation.
actorstringYes—Cognito subject or user UUID of the accepting user.

Output Schema ​

FieldTypeRequiredDefaultDescription
acceptedbooleanYes—Whether the invitation produced or confirmed a membership.
reasonstringNo—Stable outcome reason for idempotent or rejected cases.
messagestringNo—Human-readable outcome detail.
organization_uuiduuidNo—Organization joined by the accepting user.
membership_uuiduuidNo—Created or existing organization membership UUID.
rolestringNo—Organization role granted by the invitation.
actorstringNo—Authenticated principal that accepted the invitation.
failure_reasonstringNo—Human-readable explanation when invitation acceptance fails.
failure_typestringNo—Stable category for an invitation-acceptance failure.
failed_actionstringNo—Action that failed during invitation acceptance.
failed_at_statestringNo—Workflow state in which invitation acceptance failed.
failed_stepstringNo—DAG step that failed, when applicable.
failed_layerstringNo—DAG layer that failed, when applicable.
errorstringNo—Underlying error message exposed by the workflow engine.
error_typestringNo—Underlying error category exposed by the workflow engine.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
initiatedYesNo—validate—
joiningNoNo—complete—
validatingNoNo—join—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
initiatedvalidatevalidating—
validatingjoinjoining—
joiningcompletecompleted—
initiatedfailfailed—
validatingfailfailed—
joiningfailfailed—

API Usage ​

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

{
  "workflow_type": "identity.org-invitation.accept",
  "initial_data": {
    "token": "value",
    "actor": "value"
  }
}