Appearance
identity.app.set-branding ​
Set per-app end-user email HTML and display branding
Store per-app branding for end-user mail and hosted login chrome.
Inputs:
- actor, organization_uuid, identity_app_uuid (required)
- display_name: optional product name shown in mail and on login
- logo_url: optional https logo URL
- primary_color / background_color: optional #RGB or #RRGGBB
- locale: optional pt-BR or en (hosted-login copy)
- account_portal: optional bool. When true, this app's chrome styles login.orkestia.dev/account for the org (cleared on sibling apps).
- emails: optional object keyed by password_reset / email_verify / end_user_invite. Each value is {subject?, html?, text?}. html and text must contain when set. html: null reverts that kind.
Outputs: identity_app_uuid, custom_templates, default_templates, display_name, logo_url, primary_color, background_color, locale, account_portal
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 | — | — |
display_name | string | No | — | — |
logo_url | string | No | — | — |
primary_color | string | No | — | — |
background_color | string | No | — | — |
locale | string | No | — | — |
account_portal | boolean | No | — | — |
emails | dict | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
identity_app_uuid | uuid | Yes | — | — |
custom_templates | list | No | — | — |
default_templates | list | No | — | — |
display_name | string | No | — | — |
logo_url | string | No | — | — |
primary_color | string | No | — | — |
background_color | string | No | — | — |
locale | string | No | — | — |
account_portal | 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 | — |
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-branding",
"initial_data": {
"actor": "value",
"organization_uuid": "value",
"identity_app_uuid": "value"
}
}