-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplatform-config-openapi.yaml
More file actions
2659 lines (2649 loc) · 110 KB
/
Copy pathplatform-config-openapi.yaml
File metadata and controls
2659 lines (2649 loc) · 110 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: Sphereon Platform Config API
version: 0.1.0
x-products: [edk, vdx]
x-product-descriptions:
edk: |
API for configuring the singleton tenant-owned EDK services.
EDK has at most one tenant-owned authorization server, one OID4VCI issuer,
and one OID4VP verifier per tenant. Configuration paths are therefore
scoped by tenant only, without an instance id.
The API covers OAuth2/OIDC authorization-server settings for tokens,
grants, feature policy, and the `/clients` registry for public and
confidential clients. It also exposes sectioned OID4VCI issuer and OID4VP
verifier configuration for runtime settings that are not owned by
credential-design, status-list, or DCQL APIs.
vdx: |
API for configuring VDX tenant service instances.
VDX can host multiple authorization server, OID4VCI issuer, and OID4VP
verifier instances per tenant. Instance-scoped configuration paths include
`{instanceId}` and are backed by service-instance commands using VDX
software party ids as issuer and verifier instance ids.
The API covers OAuth2/OIDC authorization-server settings for tokens,
grants, feature policy, and the `/clients` registry for public and
confidential clients. It also exposes sectioned OID4VCI issuer and OID4VP
verifier configuration for runtime settings that are not owned by
credential-design, status-list, or DCQL APIs.
description: |
API for configuring tenant-owned service instances.
Platform-config is separate from platform-admin. Platform-admin manages the
tenant lifecycle, domains, signup, operator bootstrap, and platform
infrastructure. Platform-config manages the service instances a tenant runs
and the operational resources behind those instances.
EDK and VDX share the same section schema components and validation engine,
but expose different REST path surfaces. EDK has at most one tenant-owned AS,
OID4VCI issuer, and OID4VP verifier, so its configuration paths do not take
an instance id. VDX can host multiple service instances per tenant, so its
configuration paths are scoped by `{instanceId}`. The instance-scoped VDX
paths are backed by the service-instance commands and use VDX software party
ids as instance ids for issuer and verifier instances.
The API covers OAuth2/OIDC authorization-server settings for tokens,
grants, feature policy, and the `/clients` registry for public and
confidential OAuth2 clients. It also exposes sectioned OID4VCI issuer and
OID4VP verifier runtime configuration for settings that are not owned by
credential-design, status-list, or DCQL APIs.
The storage layer is intentionally hidden. Consumers work with typed
configuration resources and effective values; they do not manage raw
configuration keys or storage-specific records.
Settings resources return effective values with `{ value, source }` markers.
`source: tenant` means the tenant has an override. `source: default` means
the value is inherited from runtime defaults. PUT replaces one settings
resource and clears omitted fields back to defaults. PATCH follows JSON
Merge Patch semantics: absent fields stay unchanged and explicit `null`
clears a field.
AS clients are managed as first-class OAuth2 client registrations. A client
carries `clientType: public` or `clientType: confidential`; confidential
client secrets are accepted on writes but are never returned.
contact:
name: Sphereon International B.V.
email: support@sphereon.com
url: https://sphereon.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.example.com/api/platform/config/v1
description: Production server.
- url: http://localhost:8080/api/platform/config/v1
description: Local development server.
security:
- bearer: []
tags:
- name: AsInstances
description: OAuth2/OIDC authorization-server instance lifecycle.
- name: AsTokenSettings
description: Token lifetime and token-format settings for authorization-server instances.
- name: AsGrantSettings
description: Grant type, response type, and scope settings for authorization-server instances.
- name: AsFeatures
description: Typed OAuth2/OIDC feature policy for authorization-server instances.
- name: AsClients
description: OAuth2 public and confidential client registrations for authorization-server instances.
- name: AsIdentities
description: Authenticating identities, their login identifiers and credentials, and optional party bindings for authorization-server instances.
- name: Oid4vciIssuerMetadataSettings
description: OID4VCI issuer metadata and display settings.
- name: Oid4vciIssuerSecuritySettings
description: OID4VCI issuer credential response and request encryption settings.
- name: Oid4vciIssuerIssuanceSettings
description: OID4VCI issuer issuance tuning settings.
- name: Oid4vpVerifierClientSettings
description: OID4VP verifier client identity and redirect settings.
- name: Oid4vpVerifierRequestObjectSigningSettings
description: OID4VP verifier request-object signing settings.
- name: Oid4vpVerifierSessionSettings
description: OID4VP verifier authorization-session lifetime settings.
- name: Oid4vpVerifierReconciliationSettings
description: OID4VP verifier identity reconciliation settings.
- name: Oid4vciIssuerInstances
description: OID4VCI issuer instance lifecycle. VDX party ids are the instance ids.
- name: Oid4vpVerifierInstances
description: OID4VP verifier instance lifecycle. VDX party ids are the instance ids.
- name: KmsProviders
description: >
Manage a tenant's KMS providers — the key-management backends that hold and operate the tenant's
cryptographic keys. Create additional software providers, list them, and enable or disable them.
- name: SecretProviders
description: >
Select and configure the tenant's secret provider — the backend that resolves and stores the
tenant's secret references. Reads cascade tenant-first then the application default then the
read-only environment floor; writes route to the tenant's selected provider. Credentials are
supplied as references and are never returned.
- name: EmailAccounts
description: >
Manage tenant SMTP mail accounts. Accounts are EXTERNAL software parties with an EMAIL_SERVER
capability and configuration rooted at `vdx.service.email.accounts.<accountId>.*`. Accounts
created for the platform tenant act as named defaults that tenant runtimes can inherit unless
the tenant creates an account with its own sender and SMTP settings.
paths:
/tenants/{tenantId}/oauth2/as/instances:
post:
tags: [AsInstances]
summary: Create an AS instance
description: >
Creates an OAuth2/OIDC authorization-server instance for a tenant. The
command writes descriptor keys under `oauth2.servers.<slug>.*` and
enforces the tenant service-instance policy before writing.
operationId: createAsInstance
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/CreateAsInstanceRequest'
example:
tenantId: 7b3c2d9e-1f4a-4c8b-9e2d-5a6f7c8b9d01
slug: default
issuer: https://auth.acme.example
signingAlgorithm: ES256
userBacking: local
scopes: [openid, profile, email]
claimMappings:
email: email
name: displayName
responses:
'201':
description: Created AS instance.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsInstance'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
get:
tags: [AsInstances]
summary: List AS instances
description: Lists AS instances materialized from `oauth2.servers.<slug>.issuer` rows for the tenant.
operationId: listAsInstances
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/PageQuery'
- $ref: './platform-config-components.yml#/components/parameters/SizeQuery'
responses:
'200':
description: AS instances.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsInstanceList'
example:
items:
- tenantId: 7b3c2d9e-1f4a-4c8b-9e2d-5a6f7c8b9d01
slug: default
issuer: https://auth.acme.example
signingAlgorithm: ES256
userBacking: local
scopes: [openid, profile, email]
claimMappings:
email: email
page:
page: 0
size: 20
totalElements: 1
totalPages: 1
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
/tenants/{tenantId}/oauth2/as/instances/{slug}:
get:
tags: [AsInstances]
summary: Get an AS instance
operationId: getAsInstance
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/AsSlug'
responses:
'200':
description: AS instance.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsInstance'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
put:
tags: [AsInstances]
summary: Update an AS instance descriptor
operationId: updateAsInstance
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/AsSlug'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/UpdateAsInstanceRequest'
responses:
'200':
description: Updated AS instance.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsInstance'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
delete:
tags: [AsInstances]
summary: Delete an AS instance
description: Deletes every tenant config key under `oauth2.servers.<slug>.`.
operationId: deleteAsInstance
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/AsSlug'
responses:
'200':
description: Delete result.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/DeleteAsInstanceResult'
example:
deleted: true
/tenants/{tenantId}/kms/providers:
post:
tags: [KmsProviders]
summary: Create a software KMS provider
description: >
Adds a software KMS provider to a tenant. You supply an identifier and optional settings; key
storage and protection are managed for you, so no filesystem paths or secrets are accepted. The
provider becomes available to the tenant immediately. Only the `software` provider type is
supported today.
operationId: createKmsProvider
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/CreateKmsProviderRequest'
example:
providerId: acme-secondary
type: software
autoCreateCertificate: true
responses:
'201':
description: Created KMS provider.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/KmsProvider'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
get:
tags: [KmsProviders]
summary: List a tenant's KMS providers
description: Returns the KMS providers configured for the tenant, including the primary `_tenant_` provider.
operationId: listKmsProviders
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
responses:
'200':
description: KMS providers.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/KmsProviderList'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
/tenants/{tenantId}/kms/providers/{providerId}:
get:
tags: [KmsProviders]
summary: Get a KMS provider
description: Returns a single KMS provider for the tenant.
operationId: getKmsProvider
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/KmsProviderId'
responses:
'200':
description: KMS provider.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/KmsProvider'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
put:
tags: [KmsProviders]
summary: Update a KMS provider
description: Updates a KMS provider's mutable settings — its enabled state and whether it auto-creates certificates.
operationId: updateKmsProvider
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/KmsProviderId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/UpdateKmsProviderRequest'
responses:
'200':
description: Updated KMS provider.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/KmsProvider'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
/tenants/{tenantId}/kms/providers/{providerId}/enable:
patch:
tags: [KmsProviders]
summary: Enable or disable a KMS provider
description: >
Enables or disables a KMS provider for the tenant. The tenant's primary `_tenant_` provider holds the
tenant's key material and cannot be disabled.
operationId: enableKmsProvider
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/KmsProviderId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EnableKmsProviderRequest'
example:
enabled: true
responses:
'200':
description: Updated KMS provider.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/KmsProvider'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
/tenants/{tenantId}/secrets/provider:
get:
tags: [SecretProviders]
summary: Get the tenant's selected secret provider
description: >
Returns the secret provider selected for the tenant, identified by its type. When no tenant
provider is selected the tenant inherits the application default and ultimately the read-only
environment floor. Plaintext secrets and credential references are never returned; the response
reports only the credential mode together with the partition strategy and instance id that
determine how addresses are sharded.
operationId: getSecretProvider
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Selected secret provider.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/SecretProvider'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
put:
tags: [SecretProviders]
summary: Select and configure the tenant's secret provider
description: >
Selects and configures the secret provider that resolves and stores the tenant's secret
references. The concrete request shape is chosen by `type`. Credentials are supplied as
references resolved at runtime and are never returned. The optional `partitionStrategy` and
`instanceId` control how the provider shards tenant and instance addresses; when omitted the
per-type default strategy applies.
operationId: putSecretProvider
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/SetSecretProviderRequest'
example:
type: vault
partitionStrategy: TENANT_PATH_INSTANCE_PATH
address: https://vault.acme.internal
credentialRef:
ref: ${env:ACME_VAULT_TOKEN}
responses:
'200':
description: Selected secret provider.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/SecretProvider'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
/tenants/{tenantId}/secrets/values:
put:
tags: [SecretProviders]
summary: Write secret values through the tenant's selected provider
description: >
Writes one or more secret values through the tenant's selected writable secret provider and
returns the canonical reference for each key. Values are write-only; only the resulting
references are returned so they can be stored in configuration. The selected provider must be
writable — a read-only provider (such as the environment floor or a Kubernetes secret mount)
is rejected.
operationId: putSecretValues
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/SecretValuesWriteRequest'
example:
values:
idp/idp-client-secret: super-secret-value
responses:
'200':
description: Canonical references for the written values.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/SecretValuesWriteResult'
example:
references:
idp/idp-client-secret:
ref: ${secret:idp/idp-client-secret}
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
/tenants/{tenantId}/email/accounts:
get:
tags: [EmailAccounts]
summary: List tenant email accounts
description: >
Lists SMTP mail accounts registered for the tenant. For the platform tenant these accounts are
named platform defaults; regular tenants can add their own accounts to send mail with their
own sender name, address, and SMTP server.
operationId: listEmailAccounts
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/ManagementModeQuery'
- $ref: './platform-config-components.yml#/components/parameters/LifecycleStatusQuery'
- $ref: './platform-config-components.yml#/components/parameters/PageQuery'
- $ref: './platform-config-components.yml#/components/parameters/SizeQuery'
responses:
'200':
description: Tenant email accounts.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountList'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
post:
tags: [EmailAccounts]
summary: Create an email account
description: >
Creates an EXTERNAL software party with an EMAIL_SERVER capability and writes the mail account
config under `vdx.service.email.accounts.<accountId>.*`. SMTP credentials are supplied as a
secret reference only; plaintext passwords are not accepted.
operationId: createEmailAccount
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountCreateRequest'
example:
accountId: support
displayName: Acme Support Mail
managementMode: EXTERNAL
runtimeMode: THIRD_PARTY
config:
transportId: smtp
fromAddress: support@acme.example
fromName: Acme Support
replyTo: helpdesk@acme.example
smtp:
host: smtp.mail.example
port: 587
username: support@acme.example
passwordSecretRef: ${secret:mail/support/password}
useStarttls: true
useSsl: false
responses:
'201':
description: Created email account.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountDetail'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'401':
$ref: './common-components.yml#/components/responses/Unauthorized'
'403':
$ref: './common-components.yml#/components/responses/Forbidden'
/tenants/{tenantId}/email/accounts/{instanceId}:
get:
tags: [EmailAccounts]
summary: Get an email account
operationId: getEmailAccount
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
responses:
'200':
description: Email account detail.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountDetail'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
patch:
tags: [EmailAccounts]
summary: Update an email account
description: >
Updates the tenant mail account configuration. The path id is the email account software
party id; the stable account id remains the `<accountId>` segment in the config key prefix.
operationId: updateEmailAccount
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountUpdateRequest'
responses:
'200':
description: Updated email account.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountDetail'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
delete:
tags: [EmailAccounts]
summary: Delete an email account
description: Soft-deletes the email account software party and removes its mail config prefix.
operationId: deleteEmailAccount
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
responses:
'204':
description: Deleted.
/tenants/{tenantId}/email/accounts/{instanceId}/test-send:
post:
tags: [EmailAccounts]
summary: Send a test email through an account
description: >
Sends a test message using the selected tenant email account. The path id is the email
account software party id; the server resolves the stable `accountId` and dispatches through
the tenant-scoped email service.
operationId: testSendEmailAccount
x-products: [edk, vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountTestSendRequest'
example:
to: operator@acme.example
subject: Test email from Acme Support
responses:
'202':
description: Test email accepted by the configured transport.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/EmailAccountTestSendResponse'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
'404':
$ref: './common-components.yml#/components/responses/NotFound'
/tenants/{tenantId}/oauth2/as/tokens:
get:
tags: [AsTokenSettings]
summary: Get EDK AS token settings
description: >
Returns token lifetimes and token behavior for the tenant's singleton
EDK authorization server. EDK couples this AS to the tenant, so no
instance id is present in the path.
operationId: getAsTokenSettings
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Effective token settings with source markers.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfigView'
put:
tags: [AsTokenSettings]
summary: Replace EDK AS token settings
operationId: replaceAsTokenSettings
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfig'
example:
accessTokenLifetimeSeconds: 1800
refreshTokenLifetimeSeconds: 2592000
tokenFormat: jwt
refreshTokenRotation: true
responses:
'200':
description: Effective token settings after replacement.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
patch:
tags: [AsTokenSettings]
summary: Update EDK AS token settings
operationId: updateAsTokenSettings
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfig'
example:
accessTokenLifetimeSeconds: 900
refreshTokenLifetimeSeconds: null
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfig'
responses:
'200':
description: Effective token settings after patch.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
/tenants/{tenantId}/oauth2/as/grants:
get:
tags: [AsGrantSettings]
summary: Get EDK AS grant settings
operationId: getAsGrantSettings
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Effective grant, response-type, and scope settings.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfigView'
put:
tags: [AsGrantSettings]
summary: Replace EDK AS grant settings
operationId: replaceAsGrantSettings
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfig'
example:
grantTypesEnabled: [authorization_code, refresh_token]
responseTypesSupported: [code]
scopesSupported: [openid, profile, email]
responses:
'200':
description: Effective grant settings after replacement.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
patch:
tags: [AsGrantSettings]
summary: Update EDK AS grant settings
operationId: updateAsGrantSettings
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfig'
example:
scopesSupported: [openid, profile, email, offline_access]
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfig'
responses:
'200':
description: Effective grant settings after patch.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
/tenants/{tenantId}/oauth2/as/features:
get:
tags: [AsFeatures]
summary: Get EDK AS feature policy
operationId: getAsFeatures
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
responses:
'200':
description: Effective OAuth/OIDC feature policy.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsFeaturesConfigView'
put:
tags: [AsFeatures]
summary: Replace EDK AS feature policy
operationId: replaceAsFeatures
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsFeaturesConfig'
example:
oidc: supported
logout: supported
introspection: supported
revocation: supported
par: disabled
tokenExchange: disabled
deviceFlow: disabled
pkce: required
dpop: supported
iae: disabled
jar: supported
attestation: disabled
jarm: disabled
mtls: disabled
signedMetadata: supported
responses:
'200':
description: Effective feature policy after replacement.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsFeaturesConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
patch:
tags: [AsFeatures]
summary: Update EDK AS feature policy
operationId: updateAsFeatures
x-products: [edk]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsFeaturesConfig'
example:
pkce: required
dpop: supported
jarm: disabled
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsFeaturesConfig'
responses:
'200':
description: Effective feature policy after patch.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsFeaturesConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
/tenants/{tenantId}/oauth2/as/instances/{instanceId}/tokens:
get:
tags: [AsTokenSettings]
summary: Get AS token settings
description: Returns effective token lifetimes and token behavior for the AS instance.
operationId: getVdxAsTokenSettings
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
responses:
'200':
description: Effective token settings with source markers.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfigView'
put:
tags: [AsTokenSettings]
summary: Replace AS token settings
description: >
Replaces token settings. Provided non-null fields become tenant
overrides; omitted fields and explicit nulls clear the tenant override
and return the field to its default.
operationId: replaceVdxAsTokenSettings
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfig'
example:
accessTokenLifetimeSeconds: 1800
tokenFormat: jwt
refreshTokenRotation: true
responses:
'200':
description: Effective token settings after replacement.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
patch:
tags: [AsTokenSettings]
summary: Update AS token settings
description: >
Applies RFC 7386 merge-patch semantics to token settings. Absent fields
stay unchanged. Explicit null clears the tenant override for that field.
operationId: updateVdxAsTokenSettings
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
requestBody:
required: true
content:
application/merge-patch+json:
schema:
type: object
example:
accessTokenLifetimeSeconds: 900
refreshTokenLifetimeSeconds: null
application/json:
schema:
type: object
responses:
'200':
description: Effective token settings after patch.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsTokensConfigView'
'400':
$ref: './common-components.yml#/components/responses/ValidationError'
/tenants/{tenantId}/oauth2/as/instances/{instanceId}/grants:
get:
tags: [AsGrantSettings]
summary: Get AS grant settings
operationId: getVdxAsGrantSettings
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
responses:
'200':
description: Effective grant, response-type, and scope settings.
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfigView'
put:
tags: [AsGrantSettings]
summary: Replace AS grant settings
operationId: replaceVdxAsGrantSettings
x-products: [vdx]
parameters:
- $ref: './platform-config-components.yml#/components/parameters/TenantId'
- $ref: './platform-config-components.yml#/components/parameters/InstanceId'
requestBody:
required: true
content:
application/json:
schema:
$ref: './platform-config-components.yml#/components/schemas/AsGrantsConfig'