Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
identity_app_uuiduuidYes——
allowed_email_domainslistYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
identity_app_uuiduuidYes——
allowed_email_domainslistYes——
previous_allowed_email_domainslistNo——
effectivebooleanNo——
modestringNo——
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.set-email-domains",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value",
    "identity_app_uuid": "value",
    "allowed_email_domains": "value"
  }
}