Appearance
identity.app.add-federation ​
Register an upstream identity provider (SSO) for an app
Register an upstream identity provider (Google/GitHub/OIDC/SAML) for an app.
Inputs: actor, organization_uuid, identity_app_uuid, kind (required); config (optional object — client_id + a connection-vault secret handle + scopes; never a raw secret). Outputs: federation_provider_uuid, kind, added.
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 | — | — |
kind | string | Yes | — | — |
config | dict | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
federation_provider_uuid | uuid | Yes | — | — |
kind | string | No | — | — |
added | boolean | No | — | — |
actor | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | validate | — |
persisting | No | No | — | complete | — |
validating | No | No | — | persist | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | validate | validating | — |
validating | persist | persisting | — |
persisting | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "identity.app.add-federation",
"initial_data": {
"actor": "value",
"organization_uuid": "value",
"identity_app_uuid": "value",
"kind": "value"
}
}