SPsphereon-opensource
RouteExposures

Create a route exposure descriptor

Changed on

Creates or replaces a route exposure descriptor for an externally initiated connector capability. This registers the externally callable surface but does not by itself implement the runtime endpoint for the external caller.

post/route/exposures

Request

Request body

Example request

{
  "exposure": {
    "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"
    ]
  }
}

Response

Route exposure descriptor created.

exposureDescriptorIdstring required

Stable identifier of an externally callable route exposure descriptor.

exposedCapabilityIdstring required
owningTenantIdstring required

Tenant identifier used by tenant-scoped connector registration, routing, and execution.

organizationUnitIdstring
brandIdstring
logicalConnectionBindingIdstring required

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

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

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

allowedOperation'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE' required

Reusable operation taxonomy shared by connectors, inventory, policy, and workflows. The operation kind is logical; connector-local details live in operationName.

acceptedAuthMethodsstring[] required
requestSchemaRefstring
responseSchemaRefstring
cursorStrategystring
idempotencyKeyStrategystring
payloadLimitBytesinteger
rateLimitKeystring
auditCategory'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG'

Audit category used by governed connector invocations, runs, and externally callable route exposures.

Example response

{
  "exposureDescriptorId": "proof-vault-read-exposure",
  "exposedCapabilityId": "proof-vault-read",
  "owningTenantId": "acme",
  "organizationUnitId": "nl-ops",
  "brandId": "brand-a",
  "logicalConnectionBindingId": "brand-a-proof-vault",
  "exchangeMode": "EXTERNALLY_INITIATED_READ",
  "allowedOperation": "READ",
  "acceptedAuthMethods": [
    "bearer",
    "mtls"
  ],
  "payloadLimitBytes": 1048576,
  "auditCategory": "EXTERNAL_EXCHANGE"
}

Changes

  • 60cb8c70871bRevision changes
    • breaking

      removed the enum value EXTERNALLY_INITIATED_READ_FROM_VDX of the request property /

    • breaking

      removed the enum value EXTERNALLY_INITIATED_WRITE_INTO_VDX of the request property /

    • 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 EXTERNALLY_INITIATED_READ enum value to the request property /

    • info

      added the new EXTERNALLY_INITIATED_WRITE enum value to the request property /

    • 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