data.appdata.structure.query

List appdata databases, tables, and fields for an identity app

List the applied appdata databases, tables, and fields for an identity app.

Operator/discovery surface for the console: given an organization and an identity app it returns the declared virtual structure so a UI can prefill searchable database/table pickers, build field-aware record forms, and expose indexed-field filters. Read-only — never mutates metadata.

Overview

Property	Value
Workflow type	Atomic
Library	App-appdata
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Authenticated organization UUID
identity_app_uuid	uuid	Yes	—	Identity app UUID owning the data
database_slug	string	No	—	Optional single-database filter
include_fields	boolean	No	True	Include field descriptors
request_id	string	No	—	Caller request id for audit correlation
actor	string	No	—	Workflow caller or agent identifier

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	Organization UUID echoed from input
identity_app_uuid	uuid	Yes	—	Identity app UUID echoed from input
databases	list	Yes	—	Virtual databases (slug, name, status)
tables	list	Yes	—	Virtual tables keyed by database + table slug
fields	list	Yes	—	Virtual field descriptors (empty when include_fields is false)
database_count	integer	Yes	—	Number of databases returned
table_count	integer	Yes	—	Number of tables returned
field_count	integer	Yes	—	Number of fields returned
error	string	No	—	Error message when the read failed
error_type	string	No	—	Error class name when the read failed

States

State	Initial	Terminal	Success	Auto-advance	Description
done	Yes	Yes	Yes	—	—

Outcomes

Outcome	Type	Description	State Data Keys
queried	SUCCESS	List appdata databases, tables, and fields for an identity app	database_count, table_count, field_count
failed	FAILURE	Appdata workflow failed	failure_reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.appdata.structure.query",
  "initial_data": {
    "organization_uuid": "value",
    "identity_app_uuid": "value"
  }
}