identity.api-token.query ​
List API tokens for the current user
List API tokens for the current user.
Inputs:
- actor: Cognito sub or user UUID (required)
- token_uuid: optional token UUID for a single-token metadata read
- include_expired: include expired tokens in the metadata list/read (optional)
- limit: page size (optional)
- offset: page offset (optional)
Outputs (terminal state_data):
- tokens: list of
- count: number returned
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
actor | string | Yes | — | Authenticated subject or user UUID whose token metadata is read. |
token_uuid | string | No | — | Optional token UUID for an exact metadata lookup; no secret is returned. |
include_expired | boolean | No | — | Whether expired tokens are included in the metadata response. |
limit | integer | No | — | Maximum number of token metadata records to return. |
offset | integer | No | — | Number of matching token metadata records to skip. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
tokens | list | Yes | — | Token metadata records; plaintext tokens and hashes are never included. |
count | integer | Yes | — | Number of token metadata records returned. |
actor | string | No | — | Authenticated principal whose token metadata was read. |
token_uuid | string | No | — | Exact token UUID filter used for the query, when supplied. |
include_expired | boolean | No | — | Whether the query included expired token metadata. |
limit | integer | No | — | Requested maximum result count. |
offset | integer | No | — | Requested result offset. |
failure_reason | string | No | — | Human-readable explanation when the metadata query fails. |
failure_type | string | No | — | Stable category for a metadata-query failure. |
failed_action | string | No | — | Action that failed during the metadata query. |
failed_at_state | string | No | — | Workflow state in which the metadata query failed. |
failed_step | string | No | — | DAG step that failed, when applicable. |
failed_layer | string | No | — | DAG layer that failed, when applicable. |
error | string | No | — | Underlying error message exposed by the workflow engine. |
error_type | string | No | — | Underlying error category exposed by the workflow engine. |
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.api-token.query",
"initial_data": {
"actor": "value"
}
}