Skip to content
Proud to collaborate with Microsoft for Startups

identity.end-user.organization.invite-member ​

Invite a person into the current end-user's active workspace

Invite a person into the CURRENT end-user's active workspace.

Principal is the injected end-user token. identity_app_uuid and the target workspace are injected (reject-on-conflict). Input: email (required), group_slug (optional, default member).

Requires workspace capability users:invite or users:invite:<group_slug>. Inviting owner requires users:invite:owner.

Outputs: end_user_uuid, email, group_slug, membership_status, created, end_user_created, invite_dispatched, email_workflow_ref.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
emailemailYes——
group_slugstringNo——
identity_app_uuiduuidNo——
app_organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
identity_app_uuiduuidNo——
app_organization_uuiduuidNo——
end_user_uuiduuidNo——
emailemailNo——
group_slugstringNo——
membership_statusstringNo——
createdbooleanNo——
end_user_createdbooleanNo——
invite_dispatchedbooleanNo——
email_workflow_refstringNo——
dispatch_errorstringNo——
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.end-user.organization.invite-member",
  "initial_data": {
    "email": "value"
  }
}