-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconnector-components.yml
More file actions
5362 lines (5235 loc) · 181 KB
/
Copy pathconnector-components.yml
File metadata and controls
5362 lines (5235 loc) · 181 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.4
info:
title: Connector Components
version: 0.1.0
description: Shared schemas, parameters, and request bodies for the Connector Registry API.
components:
parameters:
ConnectorInstanceId:
name: connectorInstanceId
in: path
description: Stable identifier of the configured connector instance. This is not the Party id; the connector instance has its own id and points at its backing Party.
required: true
schema:
$ref: '#/components/schemas/ConnectorInstanceId'
example: 3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5
IdentityId:
name: identityId
in: path
description: Stable Identity id assigned to the connector Party. Identifiers remain nested under the Identity.
required: true
schema:
$ref: '#/components/schemas/IdentityId'
example: 3a5cf979-2d89-4057-a721-c7ab884f0c68
ResourceDescriptorId:
name: resourceDescriptorId
in: path
description: Stable identifier of the resource descriptor that describes the shape, representation, and semantic meaning of a connector resource.
required: true
schema:
$ref: '#/components/schemas/ResourceDescriptorId'
example: 41436f49-040c-4f5f-9c7f-657f43762e2b
BindingId:
name: bindingId
in: path
description: Stable identifier of an operation binding, such as a configured source read or destination write operation.
required: true
schema:
$ref: '#/components/schemas/OperationBindingId'
example: 2777417e-82ce-4d3e-b96c-94e00a4d9a93
TransformationId:
name: transformationId
in: path
description: Stable identifier of a reusable transformation between resource descriptors.
required: true
schema:
$ref: '#/components/schemas/TransformationId'
example: 0e60abcc-41b5-4cc5-bec2-f0047f129341
RouteId:
name: routeId
in: path
description: Stable identifier of a connector route that composes a source operation, destination operation, optional transformation, and trigger policy.
required: true
schema:
$ref: '#/components/schemas/ConnectorRouteId'
example: 1e8ff011-2274-4f16-a7dd-bf0b4fd5262f
RunId:
name: runId
in: path
description: Stable identifier of a connector route or operation execution.
required: true
schema:
$ref: '#/components/schemas/ConnectorRunId'
example: 9a785884-63ea-4b07-9976-264a1fc595f1
InvocationBindingId:
name: invocationBindingId
in: path
description: Stable identifier of a connector invocation binding.
required: true
schema:
$ref: '#/components/schemas/ConnectorInvocationBindingId'
example: issuer-config-1:post-issuance:proof-vault
LogicalConnectionBindingId:
name: logicalConnectionBindingId
in: path
description: Stable identifier of a logical connection binding.
required: true
schema:
$ref: '#/components/schemas/LogicalConnectionBindingId'
example: brand-a-proof-vault
ExposureDescriptorId:
name: exposureDescriptorId
in: path
description: Stable identifier of a route exposure descriptor.
required: true
schema:
$ref: '#/components/schemas/RouteExposureDescriptorId'
RouteExposureGrantId:
name: grantId
in: path
required: true
schema:
$ref: '#/components/schemas/RouteExposureGrantId'
example: proof-vault-read-exposure
DataProductId:
name: dataProductId
in: path
description: Stable identifier of a connector data product descriptor.
required: true
schema:
$ref: '#/components/schemas/ConnectorDataProductId'
example: dp-proof-status
Role:
name: role
in: query
description: Filters connectors or attached resources by data-flow role.
required: false
schema:
$ref: '#/components/schemas/DataFlowRole'
example: SOURCE
OperationKind:
name: operationKind
in: query
description: Filters by the logical operation taxonomy, independent of the transport-specific operation name.
required: false
schema:
$ref: '#/components/schemas/OperationKind'
example: READ
ResourceKind:
name: resourceKind
in: query
description: Filters by logical resource kind. This does not imply a transport or serialization format.
required: false
schema:
$ref: '#/components/schemas/ResourceKind'
example: TABULAR
ConnectorType:
name: connectorType
in: query
description: Filters by extensible connector runtime family, for example http.openapi, sql.postgresql, identity.oidc, storage.vault, storage.blob, interaction.form, or internal.party-semantic-store. CSV remains a representation kind, not a connector type.
required: false
schema:
$ref: '#/components/schemas/ConnectorType'
example: http.openapi
ConnectorRunStatus:
name: status
in: query
description: Filters connector executions by lifecycle status.
required: false
schema:
$ref: '#/components/schemas/ConnectorRunStatus'
example: FAILED
RouteIdQuery:
name: routeId
in: query
description: Filters connector executions by route id.
required: false
schema:
$ref: '#/components/schemas/ConnectorRouteId'
example: 1e8ff011-2274-4f16-a7dd-bf0b4fd5262f
ConnectorInstanceIdQuery:
name: connectorInstanceId
in: query
description: Filters connector executions by the registry connector instance id.
required: false
schema:
$ref: '#/components/schemas/ConnectorInstanceId'
example: 3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5
InvocationBindingIdQuery:
name: invocationBindingId
in: query
description: Filters connector executions by Phase 5 invocation binding lineage.
required: false
schema:
$ref: '#/components/schemas/ConnectorInvocationBindingId'
example: issuer-config-1:post-issuance:proof-vault
LogicalConnectionBindingIdQuery:
name: logicalConnectionBindingId
in: query
description: Filters connector executions by logical connection binding lineage.
required: false
schema:
$ref: '#/components/schemas/LogicalConnectionBindingId'
example: brand-a-proof-vault
PhysicalConnectorInstanceIdQuery:
name: physicalConnectorInstanceId
in: query
description: Filters connector executions by physical connector instance lineage.
required: false
schema:
$ref: '#/components/schemas/ConnectorInstanceId'
example: 3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5
ConnectorExchangeModeQuery:
name: exchangeMode
in: query
description: Filters connector executions by the Phase 5 data-direction and initiation-side quadrant.
required: false
schema:
$ref: '#/components/schemas/ConnectorExchangeMode'
example: PLATFORM_INITIATED_PUSH
ProtocolSurfaceQuery:
name: protocolSurface
in: query
description: Filters connector executions by the product, protocol, form, portal, workflow, or application surface that initiated the run.
required: false
schema:
$ref: '#/components/schemas/ConnectorOwnerSurface'
example: OID4VCI
CorrelationIdQuery:
name: correlationId
in: query
description: Filters connector executions by durable route-run correlation id.
required: false
schema:
type: string
example: route-correlation-1
schemas:
ConnectorInstanceId:
type: string
format: uuid
description: Stable platform identifier for a configured connector instance.
example: 3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5
ConnectorPartyId:
type: string
format: uuid
description: Party identifier assigned to the connector instance.
example: f9c97b4e-e756-4b70-b230-6f1d9f81b426
PartyId:
type: string
format: uuid
description: Existing Party model identifier.
example: 7f23f56e-c24d-4cbe-839d-5fc09048a851
IdentityId:
type: string
format: uuid
description: Existing Identity model identifier.
example: 3a5cf979-2d89-4057-a721-c7ab884f0c68
IdentifierId:
type: string
format: uuid
description: Existing Identifier model identifier.
example: 6b1c4c89-dfe0-4ce2-b8a4-2e1d57343a6c
ResourceDescriptorId:
type: string
format: uuid
description: Stable identifier for a described external or internal resource shape.
example: 41436f49-040c-4f5f-9c7f-657f43762e2b
ConnectorId:
type: string
format: uuid
description: Stable identifier for a connector instance.
example: 5f1b2f49-1397-44a7-bf5e-11340b4777c7
FieldDescriptorId:
type: string
format: uuid
description: Stable identifier for a field within a resource descriptor.
example: f00b9edc-5498-483f-9b91-a42ef080b909
ConnectorResourceId:
type: string
format: uuid
description: Stable identifier for a resource attached to a connector instance.
example: b4cf21b1-0292-4803-8d32-9ebf9f5359a2
OperationBindingId:
type: string
format: uuid
description: Stable identifier for a connector operation binding.
example: 2777417e-82ce-4d3e-b96c-94e00a4d9a93
SemanticBindingId:
type: string
format: uuid
description: Stable identifier for a semantic binding between resource data and VDX semantics.
example: 20392e94-3b35-4a77-afc2-5e552a0a4023
TransformationId:
type: string
format: uuid
description: Stable identifier for a transformation definition.
example: 0e60abcc-41b5-4cc5-bec2-f0047f129341
ConnectorRouteId:
type: string
format: uuid
description: Stable identifier for a connector route.
example: 1e8ff011-2274-4f16-a7dd-bf0b4fd5262f
ConnectorRunId:
type: string
format: uuid
description: Stable identifier for a connector route or operation run.
example: 9a785884-63ea-4b07-9976-264a1fc595f1
ConnectorInvocationBindingId:
type: string
description: Stable identifier of the domain invocation binding that caused a connector call.
example: issuer-config-1:post-issuance:proof-vault
LogicalConnectionBindingId:
type: string
description: Stable identifier of a tenant, OU, brand, legal-entity, or channel usage binding for a physical connector instance.
example: brand-a-proof-vault
RouteExposureDescriptorId:
type: string
description: Stable identifier of an externally callable route exposure descriptor.
example: proof-vault-read-exposure
RouteExposureGrantId:
type: string
description: Stable identifier of a route exposure grant.
example: grant-proof-vault-reader
ConnectorDataProductId:
type: string
description: Stable identifier of a connector data product descriptor.
example: dp-proof-status
ConnectorType:
type: string
description: Extensible connector family identifier. This names the connector implementation or adapter family, not the transport, resource kind, or representation.
example: http.openapi
TenantId:
type: string
description: Tenant identifier used by tenant-scoped connector registration, routing, and execution.
example: acme
DataFlowRole:
type: string
description: How a connector participates in data movement. Use SOURCE for reads and DESTINATION for writes. Connectors that support both roles declare both values in supportedRoles.
enum:
- SOURCE
- DESTINATION
example: SOURCE
ConnectorLifecycleStatus:
type: string
description: Lifecycle state of a connector instance in the connector registry.
enum:
- DRAFT
- ACTIVE
- SUSPENDED
- RETIRED
example: ACTIVE
ConnectorManagementMode:
type: string
description: Indicates whether the platform manages connector runtime/configuration or references an externally managed system. Runtime placement is described separately by runtimeMode.
enum:
- MANAGED
- EXTERNAL
example: EXTERNAL
ConnectorRuntimeMode:
type: string
description: Indicates where execution happens when a connector operation is invoked.
enum:
- HOSTED
- REMOTE_AGENT
- EXTERNAL_CALLBACK
example: REMOTE_AGENT
ConnectorExchangeMode:
type: string
description: Explicit exchange quadrant. Data direction and initiation side remain separate axes in run responses.
enum:
- PLATFORM_INITIATED_PULL
- PLATFORM_INITIATED_PUSH
- EXTERNALLY_INITIATED_READ
- EXTERNALLY_INITIATED_WRITE
- SUBSCRIPTION_CALLBACK
- BIDIRECTIONAL_SYNC
example: PLATFORM_INITIATED_PUSH
ConnectorDataDirection:
type: string
description: Direction of data movement relative to the platform operating the connector.
enum:
- INBOUND
- OUTBOUND
- BIDIRECTIONAL
example: OUTBOUND
ConnectorInitiationSide:
type: string
description: Side that initiated the exchange.
enum:
- PLATFORM
- EXTERNAL
- SUBSCRIPTION_CALLBACK
- BIDIRECTIONAL_SYNC
example: PLATFORM
ConnectorOwnerSurface:
type: string
description: Product, protocol, form, portal, workflow, or application surface that owns a connector invocation binding.
enum:
- OID4VCI
- OID4VP
- FORM
- PORTAL
- WORKFLOW
- APPLICATION
example: OID4VCI
ConnectorInvocationStage:
type: string
description: Product or protocol lifecycle stage at which a connector invocation can run.
enum:
- 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
example: OID4VCI_CREDENTIAL_REQUEST
ConnectorInvocationRole:
type: string
description: Role the connector performs for a lifecycle invocation.
enum:
- ENRICHMENT_SOURCE
- EXPORT_DESTINATION
- VAULT_RETENTION
- NOTIFICATION
- BIDIRECTIONAL_SYNC
- ROUTE_ORCHESTRATION
example: VAULT_RETENTION
ConnectorExecutionTiming:
type: string
description: Timing contract for connector invocation execution.
enum:
- INLINE_REQUIRED
- INLINE_OPTIONAL
- DEFERRED_ASYNC
- DURABLE_OUTBOX
example: INLINE_REQUIRED
ConnectorFailureEffect:
type: string
description: How connector invocation failure affects the owning protocol, form, portal, or workflow.
enum:
- FAIL_PROTOCOL
- CONTINUE_WITHOUT_EFFECT
- DEAD_LETTER
- QUARANTINE
- RETRY_ONLY
example: FAIL_PROTOCOL
ConnectorDiscriminatorSource:
type: string
description: Source of a logical connection discriminator value.
enum:
- LOGICAL_CONTEXT
- AUTHENTICATED_CONTEXT
- PAYLOAD_FIELD
- STATIC_VALUE
example: LOGICAL_CONTEXT
ConnectorDiscriminatorPlacement:
type: string
description: Where a logical connection discriminator is applied to an outbound connector request.
enum:
- HEADER
- QUERY
- BODY_FIELD
- CONFIG
- METADATA
example: HEADER
ConnectorAuthOverlayMode:
type: string
description: Authentication overlay mode for a logical connection binding.
enum:
- USE_PHYSICAL_BASE
- TENANT_SECRET_REF
- DELEGATED_OAUTH_CLIENT
- MTLS_IDENTITY
- CONNECTOR_CREDENTIAL_SELECTOR
example: TENANT_SECRET_REF
ConnectorDeploymentMode:
type: string
description: Deployment mode projected into the system catalog for a logical connection binding.
enum:
- MANAGED
- EXTERNAL
- HYBRID
example: HYBRID
ConnectorAuditCategory:
type: string
description: Audit category used by governed connector invocations, runs, and externally callable route exposures.
enum:
- PROTOCOL_ISSUANCE
- PROTOCOL_VERIFICATION
- FORM
- PORTAL
- WORKFLOW
- DATASPACE
- INDUSTRIAL
- EXTERNAL_EXCHANGE
- VAULT
- SYSTEM_CATALOG
example: EXTERNAL_EXCHANGE
OperationKind:
type: string
description: Reusable operation taxonomy shared by connectors, inventory, policy, and workflows. The operation kind is logical; connector-local details live in operationName.
enum:
- READ
- WRITE
- UPDATE
- DELETE
- UPSERT
- QUERY
- SEARCH
- IMPORT
- EXPORT
- INVOKE
- DISCOVER
- VALIDATE
example: READ
OperationTransferMode:
type: string
description: Transfer semantics for an operation binding. Streaming and batching are execution modes of a logical operation, not operation kinds.
enum:
- SINGLE
- BATCH
- STREAM
default: SINGLE
example: STREAM
AccessProtocol:
type: string
description: "Transport or access protocol. This is intentionally separate from ResourceKind and RepresentationKind: for example, CSV data can be read over HTTPS, S3, SFTP, FILE, or VAULT."
enum:
- HTTP
- HTTPS
- JDBC
- ODBC
- SFTP
- FILE
- S3
- AZURE_BLOB
- GCS
- KAFKA
- AMQP
- MQTT
- OIDC
- DIDCOMM
- VAULT
- INTERNAL
- CUSTOM
example: HTTPS
ResourceKind:
type: string
description: Logical kind of resource being accessed, independent of transport and serialization. For example, a CSV file with rows is ResourceKind TABULAR and RepresentationKind CSV.
enum:
- OBJECT
- TABULAR
- DOCUMENT
- CLAIM_SET
- GRAPH
- EVENT_STREAM
- FILE
- SECRET
- CONFIGURATION
- CREDENTIAL
- PRESENTATION
- CUSTOM
example: TABULAR
RepresentationKind:
type: string
description: Data representation or serialization format, independent of transport. This is the data shape on the wire or at rest, not the connector implementation.
enum:
- JSON
- JSON_LD
- XML
- CSV
- PARQUET
- AVRO
- RDF
- JWT
- SD_JWT
- CBOR
- BINARY
- TEXT
- CUSTOM
example: CSV
ShapeKind:
type: string
description: Type of structural shape information used to describe fields and validation rules for a resource.
enum:
- SCHEMA
- OPENAPI_SCHEMA
- JSON_SCHEMA
- RDF_SHAPE
- SQL_TABLE
- CSV_HEADER
- CLAIMS_SCHEMA
- FREEFORM
example: CSV_HEADER
ContractKind:
type: string
description: Contract or schema source used to describe an external resource. Use this to point at OpenAPI documents, JSON Schema, SQL metadata, RDF shapes, CSV profiles, OIDC discovery, or custom contracts.
enum:
- OPENAPI
- JSON_SCHEMA
- SQL_SCHEMA
- RDF_SCHEMA
- CSV_PROFILE
- OIDC_DISCOVERY
- VAULT_POLICY
- CUSTOM
example: OPENAPI
BindingDirection:
type: string
description: Direction of data movement represented by an operation binding.
enum:
- INBOUND
- OUTBOUND
- BIDIRECTIONAL
example: INBOUND
TransformationLanguage:
type: string
description: Transformation representation used by a transformation definition.
enum:
- ATTRIBUTE_MAPPER
- JSONATA
- JQ
- CEL
- SQL
- TEMPLATE
- CUSTOM
example: ATTRIBUTE_MAPPER
MaterializationMode:
type: string
description: How, if at all, connector data may be retained or projected into platform storage.
enum:
- NONE
- CACHE
- PERSIST
- MIRROR
- INDEX
example: PERSIST
SecretBindingMode:
type: string
description: How credentials are referenced. Secret values are never sent inline through this API.
enum:
- SECRET_REF
- VAULT_KEY
- EXTERNAL_SECRET_REF
example: SECRET_REF
ConnectorRunStatus:
type: string
description: Execution status of a route run or connector operation run.
enum:
- QUEUED
- RUNNING
- SUCCEEDED
- FAILED
- PARTIALLY_FAILED
- CANCELLED
example: SUCCEEDED
RouteAtomicity:
type: string
description: Failure and rollback semantics expected for a route run.
enum:
- BEST_EFFORT
- PER_RECORD
- ALL_OR_NOTHING
example: PER_RECORD
DestinationDeliveryMode:
type: string
description: Delivery timing and batching behavior expected by a destination operation binding.
enum:
- SYNC
- ASYNC
- BATCH
- STREAMING
example: BATCH
DestinationAckMode:
type: string
description: Acknowledgement level a destination must provide before the platform treats delivery as complete.
enum:
- NONE
- ACCEPTED
- COMMITTED
- VERIFIED
example: COMMITTED
RetentionDeleteAction:
type: string
description: Action to apply when retention expires or deletion is required by policy.
enum:
- DELETE
- ANONYMIZE
- PSEUDONYMIZE
- TOMBSTONE
- REVIEW
example: ANONYMIZE
ConnectorInstanceCreateRequest:
type: object
description: Request to register a connector instance and create or link the backing Party. Identity data is required so the connector aggregate is Party-backed at creation time.
required:
- displayName
- connectorType
- supportedRoles
- identities
properties:
displayName:
type: string
minLength: 1
description: Human-readable name shown in administrative UIs and audit trails.
example: Workday employee profile API
description:
type: string
description: Operational purpose of the connector instance.
example: Reads employee profile attributes used for employee credential issuance.
connectorType:
$ref: '#/components/schemas/ConnectorType'
managementMode:
$ref: '#/components/schemas/ConnectorManagementMode'
runtimeMode:
$ref: '#/components/schemas/ConnectorRuntimeMode'
partyId:
$ref: '#/components/schemas/PartyId'
supportedRoles:
type: array
description: Data-flow roles supported by this connector instance.
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/DataFlowRole'
example: [SOURCE]
supportedOperations:
type: array
description: Logical operations this connector instance can perform.
uniqueItems: true
items:
$ref: '#/components/schemas/OperationKind'
example: [READ, QUERY, DISCOVER]
identities:
type: array
description: Identities assigned to the connector Party. Exactly one identity must be marked as default. Each identity must reference an existing identity or include at least one identifier.
minItems: 1
items:
$ref: '#/components/schemas/ConnectorIdentityInput'
endpoints:
type: array
description: Runtime endpoints exposed or consumed by this connector instance.
items:
$ref: '#/components/schemas/ConnectorEndpointInput'
credentials:
type: array
description: Credential references used by the connector. Secret values are never sent inline.
items:
$ref: '#/components/schemas/ConnectorCredentialRef'
configBindings:
type: array
description: Platform settings bindings that hold non-secret connector configuration and secret reference prefixes.
items:
$ref: '#/components/schemas/ConnectorConfigBindingRef'
defaultAccessProtocol:
$ref: '#/components/schemas/AccessProtocol'
defaultEgressPolicy:
$ref: '#/components/schemas/EgressPolicy'
defaultMaterializationPolicy:
$ref: '#/components/schemas/MaterializationPolicy'
metadata:
$ref: '#/components/schemas/StringMap'
example:
displayName: Workday employee profile API
description: Reads employee profile attributes used for employee credential issuance.
connectorType: http.openapi
managementMode: EXTERNAL
runtimeMode: REMOTE_AGENT
supportedRoles: [SOURCE]
supportedOperations: [READ, QUERY, DISCOVER]
identities:
- identityRole: external-system
displayName: Workday tenant acme-prod
isDefault: true
identifiers:
- identifierType: DNS_NAME
value: hr.example.com
isPrimary: true
isVerified: true
- identifierType: SYSTEM_ID
value: workday:acme-prod
isPrimary: false
isVerified: true
endpoints:
- endpointRole: data
accessProtocol: HTTPS
uri: https://hr.example.com/api/v1
isPrimary: true
credentials:
- bindingMode: SECRET_REF
secretRef: secret://tenant/acme/connectors/workday/oauth-client
credentialType: oauth2-client
label: Workday OAuth client
configBindings:
- settingsScope: service-instance
settingsKeyPrefix: connector.workday.acme-prod
defaultAccessProtocol: HTTPS
metadata:
owner_team: people-ops
ConnectorInstanceUpdateRequest:
type: object
description: Partial update for connector instance metadata, lifecycle status, supported operations, and default policies. Omitted fields remain unchanged.
properties:
displayName:
type: string
description: Updated display name.
example: Workday employee profile API
description:
type: string
description: Updated operational description.
example: Reads employee profile attributes through the regional HR integration.
lifecycleStatus:
$ref: '#/components/schemas/ConnectorLifecycleStatus'
managementMode:
$ref: '#/components/schemas/ConnectorManagementMode'
runtimeMode:
$ref: '#/components/schemas/ConnectorRuntimeMode'
supportedRoles:
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/DataFlowRole'
supportedOperations:
type: array
uniqueItems: true
items:
$ref: '#/components/schemas/OperationKind'
defaultAccessProtocol:
$ref: '#/components/schemas/AccessProtocol'
defaultEgressPolicy:
$ref: '#/components/schemas/EgressPolicy'
defaultMaterializationPolicy:
$ref: '#/components/schemas/MaterializationPolicy'
metadata:
$ref: '#/components/schemas/StringMap'
example:
lifecycleStatus: ACTIVE
supportedOperations: [READ, QUERY, DISCOVER]
metadata:
owner_team: people-ops
support_queue: hr-integrations
ConnectorInstance:
type: object
description: Registered connector instance with its own stable id and a backing Party id. Runtime credentials are represented only as references.
required:
- connectorInstanceId
- partyId
- displayName
- connectorType
- lifecycleStatus
- supportedRoles
- createdAt
- updatedAt
properties:
connectorInstanceId:
$ref: '#/components/schemas/ConnectorInstanceId'
partyId:
$ref: '#/components/schemas/ConnectorPartyId'
displayName:
type: string
description: Human-readable name of the connector instance.
example: Workday employee profile API
description:
type: string
description: Operational purpose of the connector instance.
example: Reads employee profile attributes used for employee credential issuance.
connectorType:
$ref: '#/components/schemas/ConnectorType'
lifecycleStatus:
$ref: '#/components/schemas/ConnectorLifecycleStatus'
managementMode:
$ref: '#/components/schemas/ConnectorManagementMode'
runtimeMode:
$ref: '#/components/schemas/ConnectorRuntimeMode'
defaultAccessProtocol:
$ref: '#/components/schemas/AccessProtocol'
supportedRoles:
type: array
items:
$ref: '#/components/schemas/DataFlowRole'
supportedOperations:
type: array
items:
$ref: '#/components/schemas/OperationKind'
identities:
type: array
items:
$ref: '#/components/schemas/ConnectorIdentity'
endpoints:
type: array
items:
$ref: '#/components/schemas/ConnectorEndpoint'
credentials:
type: array
items:
$ref: '#/components/schemas/ConnectorCredentialRef'
configBindings:
type: array
items:
$ref: '#/components/schemas/ConnectorConfigBindingRef'
defaultEgressPolicy:
$ref: '#/components/schemas/EgressPolicy'
defaultMaterializationPolicy:
$ref: '#/components/schemas/MaterializationPolicy'
metadata:
$ref: '#/components/schemas/StringMap'
createdAt:
type: string
format: date-time
description: Creation timestamp.
example: '2026-06-18T08:30:00Z'
updatedAt:
type: string
format: date-time
description: Last update timestamp.
example: '2026-06-18T08:45:00Z'
example:
connectorInstanceId: 3f6f4f46-24fb-4c35-a7a4-bc6c7f7861f5
partyId: f9c97b4e-e756-4b70-b230-6f1d9f81b426
displayName: Workday employee profile API
description: Reads employee profile attributes used for employee credential issuance.
connectorType: http.openapi
lifecycleStatus: ACTIVE
managementMode: EXTERNAL
runtimeMode: REMOTE_AGENT
defaultAccessProtocol: HTTPS
supportedRoles: [SOURCE]
supportedOperations: [READ, QUERY, DISCOVER]
identities:
- identityId: 3a5cf979-2d89-4057-a721-c7ab884f0c68
identityRole: external-system
displayName: Workday tenant acme-prod
isDefault: true
identifiers:
- identifierId: 6b1c4c89-dfe0-4ce2-b8a4-2e1d57343a6c
identifierType: DNS_NAME
value: hr.example.com
isPrimary: true
isVerified: true
endpoints:
- endpointId: 27d8bfc5-6c75-4e4e-a78a-63ad7a924cb1
endpointRole: data
accessProtocol: HTTPS
uri: https://hr.example.com/api/v1
isPrimary: true
credentials:
- bindingMode: SECRET_REF
secretRef: secret://tenant/acme/connectors/workday/oauth-client
credentialType: oauth2-client
label: Workday OAuth client
configBindings:
- settingsScope: service-instance
settingsKeyPrefix: connector.workday.acme-prod
metadata:
owner_team: people-ops
createdAt: '2026-06-18T08:30:00Z'
updatedAt: '2026-06-18T08:45:00Z'
ConnectorIdentityInput:
type: object
description: Identity assignment for the connector Party. Use existingIdentityId to link an existing Identity, or provide displayName and identifiers to create a connector-specific Identity.
required:
- identityRole
properties:
identityRole:
type: string
description: Role of this Identity for the connector Party, for example technical-account, issuer, relying-party, or external-system.
displayName:
type: string
description: Display name for the connector identity.
example: Workday tenant acme-prod
existingIdentityId:
$ref: '#/components/schemas/IdentityId'
isDefault:
type: boolean
description: Whether this identity is the default identity for connector operations that do not select a specific identity.
default: false
example: true
identifiers:
type: array
description: Identifiers attached to this Identity. Identifiers are not attached directly to the connector.
minItems: 1
items:
$ref: '#/components/schemas/ConnectorIdentifierInput'
example:
identityRole: external-system
displayName: Workday tenant acme-prod
isDefault: true
identifiers:
- identifierType: DNS_NAME
value: hr.example.com
isPrimary: true
isVerified: true
- identifierType: SYSTEM_ID
value: workday:acme-prod
isPrimary: false
isVerified: true
ConnectorIdentity:
type: object
description: Identity assigned to the connector Party, including its nested identifiers.
required:
- identityId
- identityRole
- isDefault
properties:
identityId:
$ref: '#/components/schemas/IdentityId'
identityRole:
type: string
description: Role of this Identity for the connector Party.
example: external-system