Appearance
identity.org-invitation.reveal-link ​
Reveal the acceptance link for a pending organization invitation
Reveal the acceptance link for one pending organization invitation.
Requires the caller to be an organization admin. Returns the same URL the invitation email contains, so it can be shared over another channel when mail does not arrive.
Inputs:
- organization_uuid: Organization the invitation belongs to (required)
- invitation_uuid: Invitation to reveal (required)
Outputs (terminal state_data):
- revealed: whether a usable link was produced
- invite_url: the acceptance URL, or None when not revealable
- reason: why it was not revealed (not_found / already_accepted / cancelled / expired), or None on success
- email, role, status, expires_at: invitation metadata for display
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
invitation_uuid | uuid | Yes | — | — |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
revealed | boolean | Yes | — | — |
invite_url | string | No | — | — |
reason | string | No | — | — |
invitation_uuid | uuid | No | — | — |
email | No | — | — | |
role | string | No | — | — |
status | string | No | — | — |
expires_at | datetime | No | — | — |
organization_uuid | uuid | No | — | — |
actor | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.org-invitation.reveal-link",
"initial_data": {
"organization_uuid": "value",
"invitation_uuid": "value"
}
}