SPsphereon-opensource
ConnectorInvocationBindings

List connector invocation bindings

Changed on

Lists persisted invocation bindings that connect product or protocol lifecycle stages to connector routes, operations, logical connection bindings, subset mappings, governance, and execution policies. These records are the registry surface used when an issuer, verifier, form, portal, or workflow needs a durable connector action at a named stage.

get/invocation/bindings

Request

Query parameters

ownerSurface'OID4VCI' | 'OID4VP' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'APPLICATION'

Product, protocol, form, portal, workflow, or application surface that owns a connector invocation binding.

Example:OID4VCI

Filter by the product or protocol surface that owns the invocation.

ownerReferencestring

Filter by owner-specific reference, such as issuer configuration id, verifier profile id, form id, or workflow id.

stage'OID4VCI_START' | 'OID4VCI_AUTHORIZATION' | 'OID4VCI_PRE_AUTHORIZED' | 'OID4VCI_TOKEN' | 'OID4VCI_CREDENTIAL_REQUEST' | 'OID4VCI_DEFERRED' | 'OID4VCI_PRE_ISSUE' | 'OID4VCI_POST_ISSUANCE' | 'OID4VCI_NOTIFICATION_RECEIPT' | 'OID4VP_AFTER_VALIDATION' | 'OID4VP_PRE_REQUEST_ENRICHMENT' | 'FORM_LIFECYCLE' | 'FORM_ACTION_START' | 'FORM_ACTION_COMPLETE' | 'FORM_FIELD_LOOKUP' | 'FORM_SUBMIT' | 'PORTAL_FLOW' | 'WORKFLOW_STEP_EXECUTION'

Product or protocol lifecycle stage at which a connector invocation can run.

Example:OID4VCI_CREDENTIAL_REQUEST

Filter by product or protocol lifecycle stage.

role'ENRICHMENT_SOURCE' | 'EXPORT_DESTINATION' | 'VAULT_RETENTION' | 'NOTIFICATION' | 'BIDIRECTIONAL_SYNC' | 'ROUTE_ORCHESTRATION'

Role the connector performs for a lifecycle invocation.

Example:VAULT_RETENTION

Filter by the connector's invocation role at the lifecycle stage.

logicalConnectionBindingIdstring

Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance.

Example:brand-a-proof-vault

Filter by logical connection binding used by the invocation.

pageinteger

Zero-based page index.

sizeinteger

Page size.

Response

Paged connector invocation bindings.

Example response

{
  "data": [
    {
      "invocationBindingId": "issuer-config-1:credential-request:hr-profile",
      "ownerSurface": "OID4VCI",
      "ownerReference": "issuer-config-1",
      "stage": "OID4VCI_CREDENTIAL_REQUEST",
      "role": "ENRICHMENT_SOURCE",
      "target": {
        "routeId": "1e8ff011-2274-4f16-a7dd-bf0b4fd5262f"
      },
      "exchangeMode": "PLATFORM_INITIATED_PULL",
      "logicalContext": {
        "tenantId": "acme"
      }
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 0,
    "size": 20,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}

Changes

  • 60cb8c70871bRevision changes
    • warning

      added the new EXTERNALLY_INITIATED_READ enum value to the // response property for the response status

    • warning

      added the new EXTERNALLY_INITIATED_WRITE enum value to the // response property for the response status

    • warning

      added the new INBOUND enum value to the // response property for the response status

    • warning

      added the new OUTBOUND enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      removed the EXTERNALLY_INITIATED_READ_FROM_VDX enum value from the // response property for the response status

    • info

      removed the EXTERNALLY_INITIATED_WRITE_INTO_VDX enum value from the // response property for the response status

    • info

      removed the INTO_VDX enum value from the // response property for the response status

    • info

      removed the OUT_OF_VDX enum value from the // response property for the response status

    • info

      the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status

    • info

      the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status

    • info

      the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status

    • info

      the //// response's property pattern ^sha256:[0-9a-f]{64}$ was added for the status