--- title: "Create a logical connection binding" method: POST path: "/logical/bindings" tags: ["LogicalConnectionBindings"] --- # Create a logical connection binding `POST /logical/bindings` Creates or replaces a logical connection binding for a physical connector instance. Use this resource to declare tenant, OU, brand, channel, caller, auth overlay, grant, governance, and system-catalog projection metadata without duplicating the physical connector registration. ## Request body - LogicalConnectionBindingCreateRequest — Request to persist a logical connection binding. - `binding` LogicalConnectionBinding, required — Logical usage binding for a physical connector instance, including caller context, discriminator rules, auth overlay, grants, governance defaults, and system catalog projection metadata. - `logicalConnectionBindingId` string, required — Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance. - `physicalConnectorInstanceId` string, uuid, required — Stable platform identifier for a configured connector instance. - `logicalContext` ConnectorLogicalContext, required — Tenant, OU, brand, legal entity, channel, product, and discriminator context used to resolve a logical connector binding. - `tenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `organizationUnitId` string - `brandId` string - `legalEntityId` string - `channel` string - `productId` string - `discriminators` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `callerParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `beneficiaryParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `discriminatorRules` ConnectorDiscriminatorRule[] - `source` 'LOGICAL_CONTEXT' | 'AUTHENTICATED_CONTEXT' | 'PAYLOAD_FIELD' | 'STATIC_VALUE', required — Source of a logical connection discriminator value. - `sourceKey` string, required - `targetKey` string, required - `placement` 'HEADER' | 'QUERY' | 'BODY_FIELD' | 'CONFIG' | 'METADATA', required — Where a logical connection discriminator is applied to an outbound connector request. - `required` boolean - `staticValue` string - `authOverlay` ConnectorAuthOverlay — Logical authentication overlay applied on top of the physical connector configuration. - `mode` 'USE_PHYSICAL_BASE' | 'TENANT_SECRET_REF' | 'DELEGATED_OAUTH_CLIENT' | 'MTLS_IDENTITY' | 'CONNECTOR_CREDENTIAL_SELECTOR' — Authentication overlay mode for a logical connection binding. - `secretRef` string - `oauthClientRef` string - `mtlsIdentityRef` string - `credentialSelector` string - `grants` LogicalConnectionGrant[] - `grantId` string, required - `grantedToTenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `grantedBy` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `allowedOperations` OperationKind[] - `active` boolean - `allowedOperations` OperationKind[] - `defaultSubsetMapping` ConnectorSubsetMapping — Field selection, lookup, output mapping, provenance, and minimization rules used by an invocation or exposure. - `inputFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `selectedFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `producedFields` ConnectorFieldSelector[] — Fields an invocation is expected to produce for later connector or protocol stages. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `outputMappings` ConnectorFieldMapping[] - `source` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `target` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `required` boolean - `sourceProvenanceFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `qualityStatusFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `redactionProfileId` string - `minimizationProfileId` string - `defaultGovernance` ConnectorGovernanceEnvelope — Governance metadata attached to connector records, invocations, and runs before data crosses a protocol, form, vault, dataspace, or external-exchange boundary. - `classification` string - `sensitivity` string - `specialCategory` boolean - `legalBasis` string - `purpose` string - `b2bUsagePurpose` string — B2B or dataspace usage purpose, separate from privacy legal basis and processing purpose. - `frameworkAgreementRef` string - `contractReference` string - `minimizationStatus` 'NOT_EVALUATED' | 'MINIMIZED' | 'REDACTED' | 'FULL_DATASET' | 'EXCESSIVE' - `retentionProfileId` string - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `crossBorderRestriction` 'NONE' | 'SAME_COUNTRY' | 'EEA_ONLY' | 'APPROVED_COUNTRIES' | 'CONTRACT_REQUIRED' | 'BLOCKED' - `encryptionRequirement` 'NONE' | 'IN_TRANSIT' | 'AT_REST' | 'AT_REST_AND_IN_TRANSIT' | 'CUSTOMER_MANAGED_KEY' - `dpiaRequired` boolean - `integrity` ConnectorIntegrityReference — Integrity and evidence references carried with governed connector ingress, egress, and run lineage. - `originalPayloadHash` string - `canonicalPayloadHash` string - `transformationHash` string - `evidenceRef` string - `vaultRef` string - `signatureRef` string - `sealRef` string - `timestampRef` string - `sourceAuthenticityVerdict` string - `outputManifestHash` string - `policyDecisionId` string - `relianceVerdict` 'NOT_EVALUATED' | 'RELIABLE' | 'CONDITIONAL' | 'NOT_RELIABLE' - `auditCategory` 'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG' - `defaultMaterializationPolicy` MaterializationPolicy — Policy for retaining, caching, indexing, or mirroring data touched by connector routes. - `mode` 'NONE' | 'CACHE' | 'PERSIST' | 'MIRROR' | 'INDEX' — How, if at all, connector data may be retained or projected into platform storage. - `ttlSeconds` integer — Time to live for materialized data in seconds. - `storageResourceDescriptorId` string, uuid — Stable identifier for a described external or internal resource shape. - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `systemCatalog` SystemCatalogProjectionMetadata — Party and deployment metadata projected from a logical connection binding into system catalog or governance views. - `operatorParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `vendorSupplierParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `deploymentRegion` string - `managementMode` 'MANAGED' | 'EXTERNAL' — Indicates whether the platform manages connector runtime/configuration or references an externally managed system. Runtime placement is described separately by runtimeMode. - `runtimeMode` 'HOSTED' | 'REMOTE_AGENT' | 'EXTERNAL_CALLBACK' — Indicates where execution happens when a connector operation is invoked. - `deploymentMode` 'MANAGED' | 'EXTERNAL' | 'HYBRID' — Deployment mode projected into the system catalog for a logical connection binding. - `dataCategoriesTouched` string[] - `downstreamRecipients` PartyRef[] - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `processorRefs` PartyRef[] - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. ## Response `201` Logical connection binding created. - LogicalConnectionBinding — Logical usage binding for a physical connector instance, including caller context, discriminator rules, auth overlay, grants, governance defaults, and system catalog projection metadata. - `logicalConnectionBindingId` string, required — Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance. - `physicalConnectorInstanceId` string, uuid, required — Stable platform identifier for a configured connector instance. - `logicalContext` ConnectorLogicalContext, required — Tenant, OU, brand, legal entity, channel, product, and discriminator context used to resolve a logical connector binding. - `tenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `organizationUnitId` string - `brandId` string - `legalEntityId` string - `channel` string - `productId` string - `discriminators` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `callerParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `beneficiaryParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `discriminatorRules` ConnectorDiscriminatorRule[] - `source` 'LOGICAL_CONTEXT' | 'AUTHENTICATED_CONTEXT' | 'PAYLOAD_FIELD' | 'STATIC_VALUE', required — Source of a logical connection discriminator value. - `sourceKey` string, required - `targetKey` string, required - `placement` 'HEADER' | 'QUERY' | 'BODY_FIELD' | 'CONFIG' | 'METADATA', required — Where a logical connection discriminator is applied to an outbound connector request. - `required` boolean - `staticValue` string - `authOverlay` ConnectorAuthOverlay — Logical authentication overlay applied on top of the physical connector configuration. - `mode` 'USE_PHYSICAL_BASE' | 'TENANT_SECRET_REF' | 'DELEGATED_OAUTH_CLIENT' | 'MTLS_IDENTITY' | 'CONNECTOR_CREDENTIAL_SELECTOR' — Authentication overlay mode for a logical connection binding. - `secretRef` string - `oauthClientRef` string - `mtlsIdentityRef` string - `credentialSelector` string - `grants` LogicalConnectionGrant[] - `grantId` string, required - `grantedToTenantId` string, required — Tenant identifier used by tenant-scoped connector registration, routing, and execution. - `grantedBy` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `allowedOperations` OperationKind[] - `active` boolean - `allowedOperations` OperationKind[] - `defaultSubsetMapping` ConnectorSubsetMapping — Field selection, lookup, output mapping, provenance, and minimization rules used by an invocation or exposure. - `inputFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `selectedFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `producedFields` ConnectorFieldSelector[] — Fields an invocation is expected to produce for later connector or protocol stages. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `outputMappings` ConnectorFieldMapping[] - `source` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `target` ConnectorFieldSelector, required — Selector for a canonical, protocol, form, proof, status, source, data product, or semantic field. - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `required` boolean - `sourceProvenanceFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `qualityStatusFields` ConnectorFieldSelector[] - `canonicalFieldPath` string - `connectorField` string - `protocolClaimPath` string - `dcqlCredentialQueryId` string - `dcqlClaimId` string - `formFieldPath` string - `proofRef` string - `statusRef` string - `tokenRef` string - `sourceFieldPath` string - `dataProductFieldScope` string - `contractAgreementTargetRef` string - `semanticReference` SemanticReference — Reference to a semantic catalog, profile, attribute, relationship type, policy classification, or vocabulary term. - `referenceType` string, required — Semantic model reference type. - `referenceId` string, required — Stable semantic reference id. - `iri` string — Optional IRI for RDF/JSON-LD and vocabulary alignment. - `version` string — Optional semantic reference version. - `required` boolean - `redactionProfileId` string - `minimizationProfileId` string - `defaultGovernance` ConnectorGovernanceEnvelope — Governance metadata attached to connector records, invocations, and runs before data crosses a protocol, form, vault, dataspace, or external-exchange boundary. - `classification` string - `sensitivity` string - `specialCategory` boolean - `legalBasis` string - `purpose` string - `b2bUsagePurpose` string — B2B or dataspace usage purpose, separate from privacy legal basis and processing purpose. - `frameworkAgreementRef` string - `contractReference` string - `minimizationStatus` 'NOT_EVALUATED' | 'MINIMIZED' | 'REDACTED' | 'FULL_DATASET' | 'EXCESSIVE' - `retentionProfileId` string - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `crossBorderRestriction` 'NONE' | 'SAME_COUNTRY' | 'EEA_ONLY' | 'APPROVED_COUNTRIES' | 'CONTRACT_REQUIRED' | 'BLOCKED' - `encryptionRequirement` 'NONE' | 'IN_TRANSIT' | 'AT_REST' | 'AT_REST_AND_IN_TRANSIT' | 'CUSTOMER_MANAGED_KEY' - `dpiaRequired` boolean - `integrity` ConnectorIntegrityReference — Integrity and evidence references carried with governed connector ingress, egress, and run lineage. - `originalPayloadHash` string - `canonicalPayloadHash` string - `transformationHash` string - `evidenceRef` string - `vaultRef` string - `signatureRef` string - `sealRef` string - `timestampRef` string - `sourceAuthenticityVerdict` string - `outputManifestHash` string - `policyDecisionId` string - `relianceVerdict` 'NOT_EVALUATED' | 'RELIABLE' | 'CONDITIONAL' | 'NOT_RELIABLE' - `auditCategory` 'PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG' - `defaultMaterializationPolicy` MaterializationPolicy — Policy for retaining, caching, indexing, or mirroring data touched by connector routes. - `mode` 'NONE' | 'CACHE' | 'PERSIST' | 'MIRROR' | 'INDEX' — How, if at all, connector data may be retained or projected into platform storage. - `ttlSeconds` integer — Time to live for materialized data in seconds. - `storageResourceDescriptorId` string, uuid — Stable identifier for a described external or internal resource shape. - `retention` RetentionSpec — Retention metadata used by governance and future compliance checks. It can be applied to fields, resources, materialized data, or dead-letter payloads. - `purpose` string — Processing purpose. - `legalBasis` string — Legal or contractual basis for retention. - `retentionPeriod` string — ISO-8601 duration, for example P30D or P7Y. - `deleteAction` 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW' — Action to apply when retention expires or deletion is required by policy. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `systemCatalog` SystemCatalogProjectionMetadata — Party and deployment metadata projected from a logical connection binding into system catalog or governance views. - `operatorParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `vendorSupplierParty` PartyRef — Neutral Party reference carried by EDK connector envelopes without importing the VDX Party repository. - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `deploymentRegion` string - `managementMode` 'MANAGED' | 'EXTERNAL' — Indicates whether the platform manages connector runtime/configuration or references an externally managed system. Runtime placement is described separately by runtimeMode. - `runtimeMode` 'HOSTED' | 'REMOTE_AGENT' | 'EXTERNAL_CALLBACK' — Indicates where execution happens when a connector operation is invoked. - `deploymentMode` 'MANAGED' | 'EXTERNAL' | 'HYBRID' — Deployment mode projected into the system catalog for a logical connection binding. - `dataCategoriesTouched` string[] - `downstreamRecipients` PartyRef[] - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. - `processorRefs` PartyRef[] - `partyId` string - `externalId` string - `partyType` string - `displayName` string - `metadata` StringMap — Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data. ## Other responses - `400` — Validation error. - `401` — Authentication is required. --- [API](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api.md) · [All operations](https://skmtc.net/sphereon-opensource/apis/connector-integration-profile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sphereon-opensource/connector-integration-profile-api/revisions/60cb8c70871b/schema)