-
Notifications
You must be signed in to change notification settings - Fork 0
/
pingone-authorize.yml
1979 lines (1979 loc) · 65.3 KB
/
pingone-authorize.yml
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.0
info:
title: PingOne Platform API - Authorize
description: The PingOne Platform API covering the PingOne Authorize service
version: '2023-06-29'
externalDocs:
url: https://apidocs.pingidentity.com/pingone/platform/v1/api/#pingone-authorize
description: PingOne Platform API Reference - Authorize APIs
servers:
- url: '{protocol}://{baseDomain}.{suffix}/v1'
description: PingOne Platform API Endpoint
variables:
suffix:
enum:
- 'asia'
- 'ca'
- 'com'
- 'com.au'
- 'eu'
default: 'com'
baseDomain:
default: 'api.pingone'
protocol:
default: 'https'
- url: '{protocol}://{baseHostname}/v1'
description: PingOne Platform API Endpoint
variables:
baseHostname:
default: 'api.pingone.com'
protocol:
default: 'https'
components:
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: OAuth bearer token (see documentation)
schemas:
LinksHATEOAS:
type: object
readOnly: true
additionalProperties: true
properties:
self:
type: object
description: An object that describes the current resource.
properties:
href:
$ref: '#/components/schemas/LinksHATEOASHref'
next:
type: object
description: An object that describes the next page of results. This property is present only if there is a next page of results and the `limit` parameter is used.
properties:
href:
$ref: '#/components/schemas/LinksHATEOASHref'
LinksHATEOASHref:
type: string
format: uri
description: The URI of the resource.
APIServer:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
accessControl:
type: object
properties:
custom:
type: object
description: Defines if the operation will use custom policy rather than the "Group" or "Scope" `accessControl` requirement.
properties:
enabled:
type: boolean
description: If `TRUE`, custom policy will be used for the endpoint. Defaults to `FALSE`.
authorizationServer:
type: object
description: A container object for properties related to the authorization server that will issue access tokens used to access the APIs.
properties:
resource:
type: object
description: The resource defines the characteristics of the OAuth 2.0 access tokens used to get access to the APIs on the API server such as the audience and scopes.
properties:
id:
type: string
description: A string that specifies the UUID of the custom PingOne resource. This property must identify a PingOne resource with a type property value of CUSTOM.
required:
- id
type:
$ref: '#/components/schemas/EnumAPIServerAuthorizationServerType'
required:
- resource
baseURLs:
type: array
description: An array of string that specifies the possible base URLs that an end-user will use to access the APIs hosted on the customer's API server. Multiple base URLs may be specified to support cases where the same API may be available from multiple URLs (for example, from a user-friendly domain URL and an internal domain URL). Base URLs must be valid absolute URLs with the https or http scheme. If the path component is non-empty, it must not end in a trailing slash. The path must not contain empty backslash, dot, or double-dot segments. It must not have a query or fragment present, and the host portion of the authority must be a DNS hostname or valid IP (IPv4 or IPv6). The length must be less than or equal to 256 characters.
items:
type: string
directory:
type: object
description: A container object for fields related to the user directory used to issue access tokens for accessing the APIs. If not provided, the `directory.type` will default to `PINGONE_SSO`.
properties:
type:
$ref: '#/components/schemas/EnumAPIServerAuthorizationServerType'
required:
- type
id:
type: string
description: A string that specifies the resource's unique identifier.
readOnly: true
name:
type: string
description: A string that specifies the API server resource name. The name value must be unique among all API servers, and it must be a valid resource name.
policy:
type: object
readOnly: true
properties:
id:
type: string
description: The ID of the root policy.
required:
- id
required:
- name
- authorizationServer
- baseURLs
APIServerDeployment:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
accessControl:
type: object
properties:
custom:
type: object
description: Defines if the operation will use custom policy rather than the "Group" or "Scope" `accessControl` requirement.
properties:
enabled:
type: boolean
default: false
description: If `TRUE`, custom policy will be used for the endpoint. Defaults to `FALSE`.
authorizationVersion:
type: object
readOnly: true
properties:
id:
type: string
description: The UUID of the last deployed policy authorization version. This is present only if custom polcies are enabled and the API service has been deployed at least once.
decisionEndpoint:
type: object
readOnly: true
properties:
id:
type: string
description: The UUID of the decision endpoint.
deployedAt:
type: string
format: date-time
readOnly: true
description: The time of most recent successful deployment. Null if the API service has never been successfully deployed.
policy:
type: object
readOnly: true
properties:
id:
type: string
description: The ID of the root policy.
status:
type: object
properties:
code:
type: string
description: |
The deployment status code.
- `POLICIES_CREATE_IN_PROGRESS` The policy bundle for the API service's managed policies is being created.
- `DECISION_ENDPOINT_CREATE_IN_PROGRESS` A decision endpoint is being created for the API service.
- `DECISION_ENDPOINT_UPDATE_IN_PROGRESS` The API service's decision endpoint is being updated.
- `DEPLOYMENT_SUCCESSFUL` The API service's policies have been successfully deployed.
- `DEPLOYMENT_FAILED` HAP-MGMT was unable to deploy the API service's policies.
- `DEPLOYMENT_UNINITIALIZED` A deployment has not yet been attempted.
enum: [POLICIES_CREATE_IN_PROGRESS, DECISION_ENDPOINT_CREATE_IN_PROGRESS, DECISION_ENDPOINT_UPDATE_IN_PROGRESS, DEPLOYMENT_SUCCESSFUL, DEPLOYMENT_FAILED, DEPLOYMENT_UNINITIALIZED]
error:
type: object
description: Error details returned if the last deployment request failed.
properties:
id:
type: string
description: A unique identifier for the error.
code:
type: string
description: A general fault code that identifies the the type of error. See [Error codes](https://apidocs.pingidentity.com/pingone/platform/v1/api/#error-codes).
message:
type: string
description: A short human-readable description of the error.
APIServerOperation:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
id:
type: string
readOnly: true
description: The ID of the API service operation. This is randomly generated when the operation is created.
name:
type: string
description: The name of the API service operation.
accessControl:
type: object
description: The access control configuration for the operation.
properties:
group:
type: object
description: The group membership requirements for the operation. The `groups` array must be non-empty when the `group` object is included. The `groups` array must not contain more than 25 elements.
properties:
groups:
type: array
minItems: 1
maxItems: 25
description: The list of groups that define the access requirements for the operation. The end user must be a member of one or more of these groups to gain access to the operation. This is a required property if `accessControl.group` is set. The ID must reference a group that exists at the time the data is persisted. There is no referential integrity between a group and this configuration. If a group is subsequently deleted, the access control configuration will continue to reference that group.
items:
type: object
properties:
element:
type: object
description: The ID of the group, wrapped in an object, for future extensibility. This is a required property if `operations.value.accessControl.group` is set.
properties:
id:
type: string
description: A UUID that specifies the group ID. This is a required property if `accessControl.group` is set.
required:
- id
required:
- element
required:
- groups
permission:
type: object
description: Defines the application permission requirements for the operation.
properties:
id:
type: string
description: An application permission ID that defines the access requirements for the operation. The end user must be entitled to the specified application permission to gain access to the operation. This is a required property if `accessControl.permission` is set.
required:
- id
scope:
type: object
description: Defines the scope membership requirements for the operation.
properties:
matchType:
$ref: '#/components/schemas/EnumAPIServerOperationMatchType'
scopes:
type: array
description: A list of scopes that define the access requirements for the operation. The client must be authorized with `ANY` or `ALL` of the scopes to be granted access, depending on the `matchType` configuration.
items:
type: object
properties:
id:
type: string
description: The ID of the scope.
required:
- id
required:
- scopes
methods:
type: array
description: The methods that define the operation. No duplicates are allowed. Each element must be a valid HTTP token, according to [RFC 7230](https://datatracker.ietf.org/doc/html/rfc7230), and cannot exceed 64 characters. An empty array is not valid. To indicate that an operation is defined for every method, the `methods` array should be set to null. The `methods` array is limited to 10 entries.
maxItems: 10
items:
$ref: '#/components/schemas/EnumAPIServerOperationMethod'
paths:
type: array
description: The paths that define the operation. The same literal pattern is not allowed within the same operation (the pattern of a `paths` element must be unique as compared to all other patterns in the same `paths` array). However, the same literal pattern is allowed in different operations (for example, OperationA, `/path1`, OperationB, `/path1` is valid). The `paths` array is limited to 10 entries.
maxItems: 10
items:
type: object
properties:
pattern:
type: string
description: |
The pattern used to identify the path or paths for the operation. The semantics of the pattern are determined by the type. For any type, the pattern can contain characters that are otherwise invalid in a URL path. Invalid characters are handled by performing matching against a percent-decoded HTTP request target path. This allows an administrator to configure patterns without worrying about percent encoding special characters.
When the `type` is `PARAMETER`, the syntax outlined in the table below is enforced. Additionally, the pattern must contain a wildcard, double wildcard or named parameter. When the `type` is `EXACT`, the pattern can be any byte sequence except for ASCII control characters such as line feeds or carriage returns. The length of the pattern cannot exceed 2048 characters. The path pattern must not contain empty path segments such as `/../`, `//`, and `/./`.
type:
$ref: '#/components/schemas/EnumAPIServerOperationPathPatternType'
required:
- pattern
- type
policy:
type: object
readOnly: true
properties:
id:
type: string
description: The ID of the root policy.
required:
- id
required:
- name
- paths
ApplicationResource:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
description:
type: string
description: The application resource's description.
id:
type: string
readOnly: true
description: The resource's unique identifier.
name:
type: string
description: The application resource name. The name value must be unique.
parent:
type: object
readOnly: true
description: The application resource's parent.
properties:
type:
$ref: '#/components/schemas/EnumApplicationResourceParentType'
id:
type: string
description: The application resource's parent ID.
required:
- type
- id
required:
- name
ApplicationResourcePermission:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
action:
type: string
description: The action associated with this permission.
description:
type: string
description: The resource's description.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
id:
type: string
description: The resource's unique identifier.
readOnly: true
resource:
type: object
description: An object that identifies the associated application resource.
readOnly: true
properties:
id:
type: string
description: The ID for the associated application resource.
name:
type: string
description: The name of the associated application resource.
required:
- action
ApplicationRole:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
description:
type: string
description: The description of the application role.
id:
type: string
readOnly: true
description: The ID of the application role.
name:
type: string
description: The name of the application role.
required:
- name
ApplicationRolePermission:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
id:
type: string
description: The ID of the application resource permission to associate with this role.
environment:
$ref: '#/components/schemas/ObjectEnvironment'
key:
type: string
readOnly: true
description:
type: string
readOnly: true
action:
type: string
readOnly: true
description: The action associated with this permission.
resource:
type: object
readOnly: true
properties:
id:
type: string
description: The ID of the application resource associated with this permission.
name:
type: string
description: The name of the applicawtion resource associated with this permission.
required:
- id
ApplicationRoleAssignment:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
id:
type: string
description: The ID of the API server operation. This is randomly generated when the operation is created.
role:
type: object
description: The role associated with the role assignment.
subject:
type: object
description: The user associated with the role assignment.
EnumAPIServerPatternType:
type: string
enum: [EXACT, PARAMETER]
description: A string that specifies the type of the pattern. Options are `EXACT` ( the verbatim pattern is compared against the path from the request using a case-sensitive comparison) and `PARAMETER` (the pattern is compared against the path from the request using a case-sensitive comparison, using the syntax below to encode wildcards and path segment captures.)
EnumAPIServerAuthorizationServerType:
type: string
enum: [PINGONE_SSO,EXTERNAL]
description: The type of authorization server that will issue access tokens. Valid options are `PINGONE_SSO` or `EXTERNAL`. Defaults to `PINGONE_SSO`. Must be the same value as the directory.type. If `EXTERNAL`, the `authorizationServer.resource` field must not be provided.
EnumApplicationResourceParentType:
type: string
enum: [PING_ONE_RESOURCE]
description: The application resource's parent type. Options are PING_ONE_RESOURCE.
EnumAPIServerOperationMatchType:
type: string
description: An enumeration defining the match type of the scope rule. `ALL` means the client must be authorized with all scopes configured in the `scopes` array to obtain access. `ANY` means the client must be authorized with one or more of the scopes.
enum: [ANY, ALL]
EnumAPIServerOperationMethod:
type: string
description: The name of the HTTP method. This value is case-sensitive.
enum: [GET, POST, PUT, PATCH, DELETE, OPTIONS]
EnumAPIServerOperationPathPatternType:
type: string
description: The type of the pattern. Options are `EXACT` (the verbatim pattern is compared against the path from the request using a case-sensitive comparison) and `PARAMETER` (the pattern is compared against the path from the request using a case-sensitive comparison, using the syntax below to encode wildcards and named parameters).
enum: [EXACT, PARAMETER]
DecisionEndpoint:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
alternateId:
type: string
description: A string that specifies alternative unique identifier for the endpoint, which provides a method for locating the resource by a known, fixed identifier.
authorizationVersion:
type: object
properties:
id:
type: string
description: A string that specifies the ID of the Authorization Version deployed to this endpoint. Versioning allows independent development and deployment of policies. If omitted, the endpoint always uses the latest policy version available from the policy editor service.
href:
type: string
description: A string that specifies the request URL for the authorization version endpoint.
title:
type: string
description: A string that specifies the title for the authorization version response.
type:
type: string
description: A string that specifies the content type for the authorization version response.
description:
type: string
description: A string that specifies the description of the policy decision resource.
id:
type: string
description: A string that specifies the resource’s unique identifier.
readOnly: true
name:
type: string
description: A string that specifies the policy decision resource name.
owned:
type: boolean
description: A boolean that when true restricts modifications of the endpoint to PingOne-owned clients.
policyId:
type: string
description: A string that specifies the ID of the root policy configured for this endpoint. If omitted, the policy editor service decides on a suitable default.
provenance:
type: string
description: A string that specifies a machine-readable identifier indicating the provenance of the current configuration. It has no meaning to the Policy Decision Service itself but exists to support integration with other services.
recentDecisionsEnabled:
type: boolean
description: A boolean that specifies whether to show recent decisions.
recentDecisions:
type: object
properties:
href:
type: string
description: A string that specifies the request URL for the recent decisions endpoint.
title:
type: string
description: A string that specifies the title for the recent decisions response.
type:
type: string
description: A string that specifies the content type for the recent decisions response.
recordRecentRequests:
type: boolean
description: A boolean that specifies whether to record a limited history of recent decision requests and responses, which can be queried through a separate API.
required:
- name
- description
- recordRecentRequests
EntityArray:
type: object
properties:
'_links':
$ref: '#/components/schemas/LinksHATEOAS'
'_embedded':
type: object
properties:
apiServers:
type: array
items:
$ref: '#/components/schemas/APIServer'
assignments:
type: array
items:
$ref: '#/components/schemas/ApplicationRoleAssignment'
decisionEndpoints:
type: array
items:
$ref: '#/components/schemas/DecisionEndpoint'
operations:
type: array
items:
$ref: '#/components/schemas/APIServerOperation'
permissions:
type: array
items:
oneOf:
- $ref: '#/components/schemas/ApplicationResourcePermission'
- $ref: '#/components/schemas/ApplicationRolePermission'
resources:
type: array
items:
$ref: '#/components/schemas/ApplicationResource'
roles:
type: array
items:
$ref: '#/components/schemas/ApplicationRole'
count:
type: number
size:
type: number
ObjectApplication:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the application resource ID associated with the object.
ObjectEnvironment:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the environment associated with the object.
ObjectOrganization:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the organization associated with the object.
ObjectPopulation:
type: object
readOnly: true
properties:
id:
type: string
readOnly: true
description: A string that specifies the population associated with the object.
P1Error:
type: object
properties:
id:
description: A unique identifier that is stored in log files and always included in an error response. This value can be used to track the error received by the client, with server-side activity included for troubleshooting purposes.
type: string
code:
description: A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
type: string
message:
description: A short description of the error. This message is intended to assist with debugging and is returned in English only.
type: string
details:
description: Additional details about the error. Optional information to help resolve the error and to display to users.
type: array
items:
type: object
properties:
code:
description: A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
type: string
target:
description: The item that caused the error (such as a form field ID or an attribute inside a JSON object).
type: string
message:
description: A short description of the error. This message is intended to assist with debugging and is returned in English only.
type: string
innerError:
description: Additional details to help the client developer resolve the fault (primarily for UI validation reasons).
type: object
properties:
rangeMinimumValue:
description: Errors that failed due to range violation. This attribute represents the minimum value of the range.
type: integer
rangeMaximumValue:
description: The maximum range or value of an attribute.
type: integer
allowedPattern:
description: A regex pattern describing an acceptable input pattern.
type: string
allowedValues:
description: A list describing acceptable values.
type: array
items:
type: string
maximumValue:
description: The maximum value allowed for the request.
type: integer
referencedValues:
type: array
items:
type: string
responses:
'400':
description: Invalid request received. Malformed JSON, malformed HTTP request.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'401':
description: Request failed due to authorization issue.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'403':
description: Request failed due to authorization issue.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'404':
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'405':
description: Invalid request received. Malformed JSON, malformed HTTP request.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'409':
description: Conflict.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'429':
description: Request was rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'500':
description: Uncaught error occurred. Platform outage
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
security:
- bearer: []
tags:
- name: Policy Decision Management
- name: Policy Decision Authorization
- name: API Servers
paths:
/environments/{environmentID}/decisionEndpoints:
get:
tags:
- Policy Decision Management
summary: READ All Decision Endpoints
operationId: readAllDecisionEndpoints
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EntityArray'
post:
tags:
- Policy Decision Management
summary: CREATE Decision Endpoint
operationId: createDecisionEndpoint
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionEndpoint'
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'201':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionEndpoint'
/environments/{environmentID}/decisionEndpoints/{decisionEndpointID}:
get:
tags:
- Policy Decision Management
summary: READ One Decision Endpoint
operationId: readOneDecisionEndpoint
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: decisionEndpointID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionEndpoint'
put:
tags:
- Policy Decision Management
summary: UPDATE Decision Endpoint
operationId: updateDecisionEndpoint
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionEndpoint'
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: decisionEndpointID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/DecisionEndpoint'
delete:
tags:
- Policy Decision Management
summary: DELETE Decision Endpoint
operationId: deleteDecisionEndpoint
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: decisionEndpointID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'204':
description: Successful response
/environments/{environmentID}/apiServers:
get:
tags:
- API Servers
summary: READ All API Servers
operationId: readAllAPIServers
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/EntityArray'
post:
tags:
- API Servers
summary: CREATE API Server
operationId: createAPIServer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/APIServer'
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'201':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/APIServer'
/environments/{environmentID}/apiServers/{apiServerID}:
get:
tags:
- API Servers
summary: READ One API Server
operationId: readOneAPIServer
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: apiServerID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/APIServer'
put:
tags:
- API Servers
summary: UPDATE API Server
operationId: updateAPIServer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/APIServer'
parameters:
- name: environmentID
in: path
schema: