Skip to content
Proud to collaborate with Microsoft for Startups

appdata.credential.list ​

List an app's direct-connection credentials

List an app's direct-connection credentials. Never returns a password.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-appdata
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Authenticated organization UUID
identity_app_uuiduuidYes—Identity app the credential reads; must own an appdata namespace in this organization
request_idstringNo—Caller request id for audit correlation
actorstringNo——
include_revokedbooleanNoFalse—

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
identity_app_uuiduuidYes——
credentialslistYes—Credential descriptors; never a password
countintegerYes——
hoststringNo——
portstringNo——
databasestringNo——
sslmodestringNo——
failure_reasonstringNo—Engine-stamped failure reason
failed_at_statestringNo—State when the workflow failed
failed_stepstringNo—Failed DAG step name
failed_layerintegerNo—Failed DAG layer index
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completeList credential
completedNoYesYes—Credential listd
failedNoYesNo—List failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
listedSUCCESSList an app's direct-connection credentialscredentials
failedFAILUREAppdata workflow failedfailure_reason

API Usage ​

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

{
  "workflow_type": "appdata.credential.list",
  "initial_data": {
    "organization_uuid": "value",
    "identity_app_uuid": "value"
  }
}