identity.app.set-email-domains ​
Restrict end-user sign-in on a live identity app to an email-domain allowlist
Set the email-domain allowlist that governs who may sign in to a live app.
Inputs:
- actor, organization_uuid (required)
- identity_app_uuid: the app (required)
- allowed_email_domains: list of bare domains, e.g. ["ifood.com.br"]. Pass [] to remove the restriction (any address may sign in).
Outputs: identity_app_uuid, allowed_email_domains, previous_allowed_email_domains, effective (whether the list governs sign-in now, i.e. the app is live), mode
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| 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 | — | — |
allowed_email_domains | list | Yes | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
identity_app_uuid | uuid | Yes | — | — |
allowed_email_domains | list | Yes | — | — |
previous_allowed_email_domains | list | No | — | — |
effective | boolean | No | — | — |
mode | string | 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 | — |
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.app.set-email-domains",
"initial_data": {
"actor": "value",
"organization_uuid": "value",
"identity_app_uuid": "value",
"allowed_email_domains": "value"
}
}