Appearance
identity.key.bind ​
Bind a key to a consumer (apphost_site, identity_app, custom)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | No | — | — |
organization_uuid | uuid | No | — | — |
key_uuid | string | Yes | — | — |
consumer_kind | string | Yes | — | — |
consumer_ref | string | Yes | — | — |
role | string | Yes | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
binding_uuid | string | Yes | — | — |
key_uuid | string | Yes | — | — |
consumer_kind | string | Yes | — | — |
consumer_ref | string | Yes | — | — |
role | string | Yes | — | — |
bound | boolean | Yes | — | — |
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.key.bind",
"initial_data": {
"key_uuid": "value",
"consumer_kind": "value",
"consumer_ref": "value",
"role": "value"
}
}