SPsphereon-opensource
RouteExposures

List route exposure descriptors

Changed on

Lists externally callable route exposure descriptors. Exposure descriptors are registry records for external read/write capabilities, including accepted auth methods, caller Party and relationship constraints, schemas, subset mapping, payload/rate limits, and audit category.

get/route/exposures

Request

Query parameters

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 backing the exposed capability.

exchangeMode'PLATFORM_INITIATED_PULL' | 'PLATFORM_INITIATED_PUSH' | 'EXTERNALLY_INITIATED_READ' | 'EXTERNALLY_INITIATED_WRITE' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC'

Explicit exchange quadrant. Data direction and initiation side remain separate axes in run responses.

Example:PLATFORM_INITIATED_PUSH

Filter by the route exposure exchange quadrant.

pageinteger

Zero-based page index.

sizeinteger

Page size.

Response

Paged route exposure descriptors.

Example response

{
  "data": [
    {
      "exposureDescriptorId": "proof-vault-read-exposure",
      "exposedCapabilityId": "proof-vault-read",
      "owningTenantId": "acme",
      "logicalConnectionBindingId": "brand-a-proof-vault",
      "exchangeMode": "EXTERNALLY_INITIATED_READ",
      "allowedOperation": "READ",
      "acceptedAuthMethods": [
        "bearer",
        "mtls"
      ]
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "page": 0,
    "size": 20,
    "total": 1,
    "totalPages": 1,
    "hasMore": false
  }
}

Changes

  • 60cb8c70871bRevision changes
    • breaking

      removed the enum value EXTERNALLY_INITIATED_READ_FROM_VDX from the query request parameter exchangeMode

    • breaking

      removed the enum value EXTERNALLY_INITIATED_WRITE_INTO_VDX from the query request parameter exchangeMode

    • 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

    • info

      added the new enum value EXTERNALLY_INITIATED_READ to the query request parameter exchangeMode

    • info

      added the new enum value EXTERNALLY_INITIATED_WRITE to the query request parameter exchangeMode

    • 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