Skip to content
Proud to collaborate with Microsoft for Startups

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 ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes—Authenticated subject or user UUID whose token metadata is read.
token_uuidstringNo—Optional token UUID for an exact metadata lookup; no secret is returned.
include_expiredbooleanNo—Whether expired tokens are included in the metadata response.
limitintegerNo—Maximum number of token metadata records to return.
offsetintegerNo—Number of matching token metadata records to skip.

Output Schema ​

FieldTypeRequiredDefaultDescription
tokenslistYes—Token metadata records; plaintext tokens and hashes are never included.
countintegerYes—Number of token metadata records returned.
actorstringNo—Authenticated principal whose token metadata was read.
token_uuidstringNo—Exact token UUID filter used for the query, when supplied.
include_expiredbooleanNo—Whether the query included expired token metadata.
limitintegerNo—Requested maximum result count.
offsetintegerNo—Requested result offset.
failure_reasonstringNo—Human-readable explanation when the metadata query fails.
failure_typestringNo—Stable category for a metadata-query failure.
failed_actionstringNo—Action that failed during the metadata query.
failed_at_statestringNo—Workflow state in which the metadata query failed.
failed_stepstringNo—DAG step that failed, when applicable.
failed_layerstringNo—DAG layer that failed, when applicable.
errorstringNo—Underlying error message exposed by the workflow engine.
error_typestringNo—Underlying error category exposed by the workflow engine.

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.api-token.query",
  "initial_data": {
    "actor": "value"
  }
}