Skip to content
Proud to collaborate with Microsoft for Startups

identity.app-organization.invite ​

Invite an end-user to a workspace with a role (pending membership)

Invite an end-user to a workspace with a role (pending/invited membership).

Same shape as add-member, but the membership is created with status invited (the invitee accepts out of band). Inputs: actor, organization_uuid, identity_app_uuid, app_organization_uuid (all required); one of end_user_uuid or email; group_slug (optional). Outputs: app_organization_uuid, end_user_uuid, group_slug, membership_status, created.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
identity_app_uuiduuidYes——
app_organization_uuiduuidYes——
end_user_uuiduuidNo——
emailemailNo——
group_slugstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
app_organization_uuiduuidNo——
end_user_uuiduuidNo——
group_slugstringNo——
membership_statusstringNo——
createdbooleanNo——
active_bootstrappedbooleanNo——
identity_app_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
reasonstringNo——

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.app-organization.invite",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "app_organization_uuid": "value"
  }
}