identity.end-user.invite

Mail an admin-provisioned end-user their access to an app

Mail an admin-provisioned end-user their access to an app.

Issues a single-use invite token (purpose="invite") and sends the internal end_user_invite email. A password-setting token is issued when the global account has no password. A redeem token is also issued when a password exists but the email is unverified — /authorize cannot use that password until the mailbox is proven. If they already have a verified password, the email tells them to sign in instead and no token is created.

Inputs:

• actor, organization_uuid, identity_app_uuid (required)
• one of end_user_uuid or email (required) to identify the target
• app_organization_uuid (optional — names the workspace in the email)
• resend (optional bool — marks the email as a reminder)
• expires_in_hours (optional, default 72)

Outputs (terminal state_data):

• end_user_uuid, email, credential_required, invite_issued, expires_at
• email_dispatched, email_workflow_ref, dispatch_error The invite token itself is never returned.

Overview

Property	Value
Workflow type	Linear
Library	App-identity
Version	1.0

Input Schema

Field	Type	Required	Default	Description
actor	string	Yes	—	—
organization_uuid	uuid	Yes	—	—
identity_app_uuid	uuid	Yes	—	—
end_user_uuid	uuid	No	—	—
email	email	No	—	—
app_organization_uuid	uuid	No	—	—
resend	boolean	No	—	—
expires_in_hours	integer	No	—	—

Output Schema

Field	Type	Required	Default	Description
identity_app_uuid	uuid	No	—	—
end_user_uuid	uuid	No	—	—
email	email	No	—	—
credential_required	boolean	No	—	—
invite_issued	boolean	No	—	—
expires_at	datetime	No	—	—
email_dispatched	boolean	No	—	—
email_workflow_ref	string	No	—	—
dispatch_error	string	No	—	—
app_name	string	No	—	—
workspace_name	string	No	—	—
role	string	No	—	—
resend	boolean	No	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
reason	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Issue the invite token
dispatching	No	No	—	dispatch	Send the invite email
completed	No	Yes	Yes	—	Invite processed
failed	No	Yes	No	—	Invite failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	dispatching	—
dispatching	dispatch	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "identity.end-user.invite",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value"
  }
}