Sign in

v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
RouteExposures

Create a route exposure grant

post/route/exposures/{exposureDescriptorId}/grants

Path parameters

exposureDescriptorIdstring required

Stable identifier of an externally callable route exposure descriptor.

Example:proof-vault-read-exposure

Stable identifier of a route exposure descriptor.

Request body

allowedAuthMethodsstring[]
allowedOperationsOperationKind[]
status'ACTIVE' | 'SUSPENDED' | 'REVOKED' | 'EXPIRED'
validFromstring date-time
validUntilstring date-time
maxUsesinteger
metadataobject

Example request

{
  "callerParty": {
    "partyId": "party-subject",
    "externalId": "urn:external:asset:press-1",
    "partyType": "organization",
    "displayName": "Example BV",
    "metadata": {
      "owner_team": "people-ops",
      "domain": "employee-licensing"
    }
  },
  "grantedBy": {
    "partyId": "party-subject",
    "externalId": "urn:external:asset:press-1",
    "partyType": "organization",
    "displayName": "Example BV",
    "metadata": {
      "owner_team": "people-ops",
      "domain": "employee-licensing"
    }
  },
  "allowedOperations": [
    "READ"
  ]
}

Response

Route exposure grant created.

grantIdstring required

Stable identifier of a route exposure grant.

exposureDescriptorIdstring required

Stable identifier of an externally callable route exposure descriptor.

owningTenantIdstring required

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

allowedAuthMethodsstring[]
allowedOperationsOperationKind[]
status'ACTIVE' | 'SUSPENDED' | 'REVOKED' | 'EXPIRED' required
validFromstring date-time
validUntilstring date-time
maxUsesinteger
useCountinteger required
metadataobject
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "grantId": "grant-proof-vault-reader",
  "exposureDescriptorId": "proof-vault-read-exposure",
  "owningTenantId": "acme",
  "callerParty": {
    "partyId": "party-subject",
    "externalId": "urn:external:asset:press-1",
    "partyType": "organization",
    "displayName": "Example BV",
    "metadata": {
      "owner_team": "people-ops",
      "domain": "employee-licensing"
    }
  },
  "grantedBy": {
    "partyId": "party-subject",
    "externalId": "urn:external:asset:press-1",
    "partyType": "organization",
    "displayName": "Example BV",
    "metadata": {
      "owner_team": "people-ops",
      "domain": "employee-licensing"
    }
  },
  "allowedOperations": [
    "READ"
  ]
}