-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathgovernance-production-requests-admin-v2-reference-noEnums-oneOfInheritance.yaml
More file actions
9156 lines (9073 loc) · 380 KB
/
Copy pathgovernance-production-requests-admin-v2-reference-noEnums-oneOfInheritance.yaml
File metadata and controls
9156 lines (9073 loc) · 380 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.3
info:
title: Access Requests - V2
description: Allows customers to easily access the Okta API
termsOfService: https://developer.okta.com/terms/
contact:
name: Okta Developer Team
url: https://developer.okta.com/
email: devex-public@okta.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 3.2.0
x-logo:
url: logo.svg
backgroundColor: transparent
altText: Okta Developer
servers:
- url: https://{yourOktaDomain}
variables:
yourOktaDomain:
default: subdomain.okta.com
description: The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains.
tags:
- name: Request Conditions
description: |
Request conditions define what resources and access levels requesters can request from their resource catalog.
Each request condition defines the following:
- Who can request access
- What resource and access level they can request
- How long the access should be granted for
- What request sequence to use for approval
- A priority to control what condition should take precedence when a requester matches against multiple request conditions
See [Access request conditions](https://help.okta.com/oie/en-us/content/topics/identity-governance/access-requests/rcar-conditions.htm) for more information on Access request conditions and Identity Governance.
x-okta-lifecycle:
lifecycle: GA
- name: Request Sequences
description: |-
The Request Sequences API allows you to retrieve request sequence data necessary for managing request conditions. Request sequences are created in the Okta Access Requets app and define a series of steps (questions, approval tasks, and custom tasks) that must be completed for a requester to gain access to the resource.
When you create a request condition, you must reference a request sequence. You can reuse request sequences with many request conditions.
See [Configure an approval sequence](https://help.okta.com/okta_help.htm?type=oie&id=csh-rcar-approval-sequences) in the product documentation.
> **Note:** Each org has a maximum of 250 request sequences.
x-okta-lifecycle:
lifecycle: GA
- name: Request Settings
description: |
Request settings are useful for managing your org's access requests.
Request settings can be read and updated at the org and resource level.
The information provided by request settings may be used to determine if another operation, such as creating a request condition, is valid for a particular organization and resource.
See [Access requests - Get started](https://help.okta.com/oie/en-us/content/topics/identity-governance/access-requests/ar-get-started.htm) for information on setting up access requests for your organization.
x-okta-lifecycle:
lifecycle: GA
- name: Requests
description: |
Okta Access Requests automate the process of requesting access to resources managed by access request conditions.
Access request conditions define the resource to access, who can request access, length of access, and the approval sequence. For more information, see [Access request conditions](https://help.okta.com/okta_help.htm?type=oie&id=csh-rcar-conditions). See also the following APIs: [Request Conditions](https://developer.okta.com/docs/api/iga/openapi/governance.requests.admin.v2/tag/Request-Conditions/#tag/Request-Conditions) and [Request Sequences](https://developer.okta.com/docs/api/iga/openapi/governance.requests.admin.v2/tag/Request-Sequences/#tag/Request-Sequences).
Manage the access request process directly with the Requests API.
> **Notes:**
> * Each org has a maximum of 10,000 open or pending requests.
> * Each org has a maximum of 50,000 resolved requests that are accessible within an app.
See [Access Requests](https://help.okta.com/oie/en-us/content/topics/identity-governance/access-requests/ar-overview.htm) for more information on Access Requests and Identity Governance.
x-okta-lifecycle:
lifecycle: GA
- name: Catalogs
description: |
A catalog entry represents a requestable resource for [Access Requests](https://help.okta.com/okta_help.htm?type=oie&id=ext-ar). Each requestable app or collection has a top-level entry in the catalog. These are known as parent catalog entries. Associated requestable entitlements and groups also have an entry in the catalog, known as child entries. For example, a top-level entry for Figma might have two child entries, one for requesting read-only access to Figma and one for requesting edit access.
The `parent` property in the catalog entry object shows the relationship between child and parent. The child entry's `parent` property references their respective parent entry identifier. The parent entry's `parent` property has no value. See the [CATALOG-ENTRY](https://developer.okta.com/docs/api/iga/#CATALOG-ENTRY) diagram in the [Relationships](https://developer.okta.com/docs/api/iga/#relationships) model.
Use the Catalogs API to request for catalog entries as a principal with admin privileges. You can search for a list of catalog entries based on the entry parent-child relationship using the `filter` query parameter.
x-okta-lifecycle:
lifecycle: GA
- name: Tasks
description: |
<x-lifecycle class="beta"></x-lifecycle>
The Tasks API allows you to manage tasks from access requests made through access request conditions in your Okta Identity Governance (OIG) org.
x-okta-lifecycle:
lifecycle: BETA
externalDocs:
description: Find more info here
url: https://developer.okta.com/docs/reference/core-okta-api/#design-principles
paths:
/governance/api/v2/resources/{resourceId}/request-conditions:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
operationId: listResourceRequestConditionsV2
summary: List all resource request conditions
description: |
Lists request conditions for a resource specified by `resourceId`
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.read
responses:
'200':
$ref: '#/components/responses/resource-request-conditions-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
post:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
operationId: createResourceRequestConditionV2
summary: Create a request condition
description: |
Creates a request condition to govern how a resource can be requested.
Specify the following to create a request condition:
- What resource can be requested? (`resourceId` in path)
- What access scope can be requested? (`accessScopeSettings` in request body)
- Who can request access? (`requesterSettings` in request body)
- What is the approval process? (`approvalSequenceId` in request body)
Any `requesterSettings` or `accessScopeSettings` parameters in the request body are validated against the resource's current request settings.
After a request condition is created successfully, its `status` is set to `INACTIVE`.
> **Note:** You can define a maximum of 100 conditions for each resource (app).
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/request-condition-creatable'
examples:
AppEveryone:
$ref: '#/components/examples/request-condition-creatable-00-app-everyone'
AppGroupRequesters:
$ref: '#/components/examples/request-condition-creatable-01-app-group-requesters'
AppGroupRequestersFixedDuration:
$ref: '#/components/examples/request-condition-creatable-02-app-group-requesters-fixed-duration'
AppEveryoneFixedDuration:
$ref: '#/components/examples/request-condition-creatable-03-app-everyone-fixed-duration'
AppGroupRequestersRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-04-app-group-requesters-requester-duration'
AppEveryoneRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-05-app-everyone-requester-duration'
GroupAccessEveryone:
$ref: '#/components/examples/request-condition-creatable-06-group-access-scope-everyone'
GroupAccessGroupRequesters:
$ref: '#/components/examples/request-condition-creatable-07-group-access-scope-group-requesters'
GroupAccessGroupRequestersFixedDuration:
$ref: '#/components/examples/request-condition-creatable-08-group-access-scope-group-requesters-fixed-duration'
GroupAccessEveryoneFixedDuration:
$ref: '#/components/examples/request-condition-creatable-09-group-access-scope-everyone-fixed-duration'
GroupAccessGroupRequestersRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-10-group-access-scope-group-requesters-requester-duration'
GroupAccessEveryoneRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-11-group-access-scope-everyone-requester-duration'
EntitlementBundleAccessEveryone:
$ref: '#/components/examples/request-condition-creatable-12-entitlement-bundle-access-scope-everyone'
EntitlementBundleAccessGroupRequesters:
$ref: '#/components/examples/request-condition-creatable-13-entitlement-bundle-access-scope-group-requesters'
EntitlementBundleAccessGroupRequestersFixedDuration:
$ref: '#/components/examples/request-condition-creatable-14-entitlement-bundle-access-scope-group-requesters-fixed-duration'
EntitlementBundleAccessEveryoneFixedDuration:
$ref: '#/components/examples/request-condition-creatable-15-entitlement-bundle-access-scope-everyone-fixed-duration'
EntitlementBundleAccessGroupRequestersRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-16-entitlement-bundle-access-scope-group-requesters-requester-duration'
EntitlementBundleAccessEveryoneRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-17-entitlement-bundle-access-scope-everyone-requester-duration'
TeamRequesters:
$ref: '#/components/examples/request-condition-creatable-18-team-requesters'
TeamRequestersFixedDuration:
$ref: '#/components/examples/request-condition-creatable-19-team-requesters-fixed-duration'
TeamRequestersRequesterDuration:
$ref: '#/components/examples/request-condition-creatable-20-team-requesters-requester-duration'
responses:
'201':
$ref: '#/components/responses/request-condition-create-success'
'400':
$ref: '#/components/responses/request-condition-create-bad-request'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
operationId: getResourceRequestConditionV2
summary: Retrieve a resource request condition
description: Retrieves a resource request condition
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
- $ref: '#/components/parameters/request-condition-id'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.read
responses:
'200':
$ref: '#/components/responses/resource-request-condition-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
delete:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
operationId: deleteResourceRequestConditionV2
summary: Delete a request condition
description: Deletes a request condition
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
- $ref: '#/components/parameters/request-condition-id'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
responses:
'204':
$ref: '#/components/responses/request-condition-delete-success-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
patch:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
operationId: updateResourceRequestConditionV2
summary: Update the request condition
description: |
Updates the request condition
Conditions can be updated while their status is ACTIVE, INACTIVE or INVALID.
An update will be rejected if it would lead to the condition entering an INVALID status.
While an update request body may not contain `status`, a successful update request condition operation will always result in the condition entering ACTIVE or INACTIVE status.
Any `requesterSettings`, `accessScopeSettings` in the update request body will be validated against the resource's current request settings.
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
- $ref: '#/components/parameters/request-condition-id'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/request-condition-patchable'
examples:
UpdateAllModifiableProperties:
$ref: '#/components/examples/request-condition-creatable-00-app-everyone'
responses:
'200':
$ref: '#/components/responses/request-condition-patch-success-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}/activate:
post:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
operationId: activateResourceRequestConditionV2
summary: Activate the request condition
description: |
Activates the request condition
Conditions can be activated while their status is INACTIVE.
Activating a condition allows it to provide catalog entries to endusers.
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
- $ref: '#/components/parameters/request-condition-id'
security:
- OAuth2:
- okta.accessRequests.condition.manage
responses:
'200':
$ref: '#/components/responses/request-condition-activate-success-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'409':
$ref: '#/components/responses/request-condition-activate-conflict-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/resources/{resourceId}/request-conditions/{requestConditionId}/deactivate:
post:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Conditions
operationId: deactivateResourceRequestConditionV2
summary: Deactivate the request condition
description: |
Deactivates the request condition
Conditions can be deactivated while their status is ACTIVE.
Deactivating a condition prevents the condition from providing catalog entries to endusers.
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
- $ref: '#/components/parameters/request-condition-id'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
responses:
'200':
$ref: '#/components/responses/request-condition-deactivate-success-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'409':
$ref: '#/components/responses/request-condition-deactivate-conflict-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/resources/{resourceId}/request-settings:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Settings
operationId: getRequestSettingsV2
summary: Retrieve the resource request settings
description: |-
Retrieves the request settings for a resource
Resource request settings are useful for determining what kind of request conditions
can be created or updated for a resource.
For example:
- `validAccessScopeSettings` indicates what `accessScopeSettings` may be passed in a `Create request condition` or `Update request condition` operation.
- `validRequesterSettings` indicates what `requesterSettings` may be passed in a `Create request condition` or `Update request condition` operation.
- `validAccessDurationSettings` indicates the maximum duration the user will have access to the resources.
- `validRiskSettings` indicates what `riskSettings` may be passed. Currently, it can be at the resource request settings.
- `validRequestOnBehalfOfSettings` indicates the available request on behalf of settings for the resource.
- `requestOnBehalfOfSettings` if they exist, they indicate the settings specified for request on behalf of.
- `riskSettings` if they exist, they indicate the risk settings specified for the resource.
See response examples for various possible request setting scenarios.
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.read
responses:
'200':
$ref: '#/components/responses/request-settings-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
patch:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Settings
operationId: updateResourceRequestSettingsV2
summary: Update the resource request settings
description: |
Updates the resource request settings
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/resource-request-settings-patchable'
examples:
EnableRequestOnBehalfOfSettings:
$ref: '#/components/examples/resource-request-setting-patchable-robo-00-everyone-example'
UpdateRequestOnBehalfOfSettings:
$ref: '#/components/examples/resource-request-setting-patchable-robo-01-direct-report-example'
DisableRequestOnBehalfOfSettings:
$ref: '#/components/examples/resource-request-setting-patchable-robo-02-disable-example'
RemoveRiskSettings:
$ref: '#/components/examples/resource-request-setting-patchable-risk-settings-00-request-submission-allowed-with-no-overrides-example'
UpdateRiskSettingsWithRequestSubmissionRestricted:
$ref: '#/components/examples/resource-request-setting-patchable-risk-settings-01-request-submission-restricted-example'
UpdateRiskSettingsWithRequestSubmissionAllowed:
$ref: '#/components/examples/resource-request-setting-patchable-risk-settings-02-request-submission-allowed-with-overrides-example'
UpdateRiskSettingsWithRequestSubmissionAllowedWithAds:
$ref: '#/components/examples/resource-request-setting-patchable-risk-settings-03-request-submission-allowed-with-ads-example'
UpdateRiskSettingsWithRequestSubmissionAllowedRemoveAds:
$ref: '#/components/examples/resource-request-setting-patchable-risk-settings-04-request-submission-allowed-remove-ads-example'
UpdateRiskSettingsWithRobo:
$ref: '#/components/examples/resource-request-setting-patchable-risk-settings-05-robo-example'
responses:
'200':
$ref: '#/components/responses/resource-request-settings-patch-success'
'400':
$ref: '#/components/responses/resource-request-settings-patch-bad-request-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/request-settings:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Settings
operationId: getOrgRequestSettingsV2
summary: Retrieve the org request settings
description: |
Retrieves the request settings for the org.
Org request settings indicate:
- If the Access Requests app has been provisioned
- If a customer has triggered Access Requests app provisioning in their org
- The request experiences that are supported
- If the provisioning for the Access Requests app was triggered a while ago
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.read
responses:
'200':
$ref: '#/components/responses/org-request-settings-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
patch:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Settings
operationId: updateOrgRequestSettingsV2
summary: Update the org request settings
description: |
Updates the request settings for the org
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/org-request-settings-patchable'
examples:
PatchExample:
$ref: '#/components/examples/org-request-settings-patchable-example'
NotificationsPatchExample:
$ref: '#/components/examples/org-request-settings-notifications-patchable-example'
SlackActionsPatchExample:
$ref: '#/components/examples/org-request-settings-slack-actions-patchable-example'
responses:
'200':
$ref: '#/components/responses/org-request-settings-patch-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/resources/{resourceId}/request-sequences:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Sequences
operationId: listResourceRequestSequencesV2
summary: List all resource request sequences
description: Lists access request sequences for a resource in your org
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.read
responses:
'200':
$ref: '#/components/responses/request-sequences-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/resources/{resourceId}/request-sequences/{sequenceId}:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Sequences
parameters:
- $ref: '#/components/parameters/resource-id-orn-or-okta'
- $ref: '#/components/parameters/sequence-id-parameter'
operationId: getResourceRequestSequenceV2
summary: Retrieve a resource request sequence
description: Retrieves a access request sequence referenced by the specified resource
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.read
responses:
'200':
$ref: '#/components/responses/request-sequence-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/request-sequences/{sequenceId}:
delete:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Request Sequences
operationId: deleteRequestSequenceV2
summary: Delete a request sequence
description: Deletes the access request sequence given its `id`
parameters:
- $ref: '#/components/parameters/sequence-id-parameter'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.condition.manage
responses:
'204':
$ref: '#/components/responses/request-sequence-delete-success-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/requests:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Requests
operationId: listAllRequestsV2
summary: List all requests
description: |
Lists the requests made by users in your org. Use this operation to retrieve all access requests managed by access request conditions.
Use the `filter` parameter to narrow down the results. This SCIM query string supports the following attributes:
- `status`: The status of the request. Possible values: `SUBMITTED`, `REJECTED`, `PENDING`, `APPROVED`, `DENIED`, `CANCELED`, `EXPIRED`
- `lastUpdated`: The last updated time of the request
- `requestedFor`: The Okta user ID for whom the request is made
- `resourceId`: The Okta resource ID for which the request is made
- `resourceType`: The type of resource for which the request is made. Possible values: `APPLICATION`
- `accessScopeId`: The ID of the resource access scope for which the request is made
- `accessScopeType`: The type of the resource access scope for which the request is made. Possible values: `ENTITLEMENT_BUNDLE`, `GROUP`, `APPLICATION`
Pagination parameters are accepted, and standard link headers are in the response.
parameters:
- $ref: '#/components/parameters/request-list-filter'
- $ref: '#/components/parameters/request-list-after'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/request-list-order-by'
security:
- OAuth2:
- okta.accessRequests.request.read
responses:
'200':
$ref: '#/components/responses/requests-list-success'
'400':
$ref: '#/components/responses/requests-list-bad-request'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
post:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
operationId: createRequestV2
tags:
- Requests
summary: Create a request
description: |
Creates a resource access request for a given user.
Use this operation to create access requests managed by access request conditions.
If `requestedBy` and `requestedFor` aren't the same, then you must also enable the [`requestOnBehalfOfSettings`](https://developer.okta.com/docs/api/iga/openapi/governance.requests.admin.v2/tag/Request-Settings/#tag/Request-Settings/operation/updateResourceRequestSettingsV2!path=requestOnBehalfOfSettings&t=request) parameter in the access request settings. See [Update the resource request settings](https://developer.okta.com/docs/api/iga/openapi/governance.requests.admin.v2/tag/Request-Settings/#tag/Request-Settings/operation/updateResourceRequestSettingsV2).
Include the following information in the payload:
- The Okta user ID for the user who requires access. Add the user ID in the `requestedFor.externalId` parameter.
- The catalog entry ID of the resource required by the user. Add the catalog ID in the `requested.entryId` parameter.
- If the request conditions include requester input fields, add field information in the `requesterFieldValues` array. See [Retrieve the request fields](https://developer.okta.com/docs/api/iga/openapi/governance.requests.admin.v2/tag/Catalogs/#tag/Catalogs/operation/getCatalogEntryRequestFieldsV2).
- Optional: The user ID of the person submitting the request. By default, this value is the admin user ID requesting this operation and doesn't need to be provided. However, to add a different Okta user ID for the request, include the `requestedBy.externalId` parameter in the request body.
requestBody:
required: true
description: The writable attributes of a request
content:
application/json:
schema:
$ref: '#/components/schemas/request-creatable'
examples:
AdminWhenCatalogEntryInboxApprovalNoRequesterInput:
$ref: '#/components/examples/admin-request-00-create-catalog-inbox-noinput'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.request.manage
responses:
'202':
$ref: '#/components/responses/request-create-success-response'
'400':
$ref: '#/components/responses/request-create-bad-request-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/request-create-forbidden-response'
'409':
$ref: '#/components/responses/request-create-conflict-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/requests/{requestId}:
get:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Requests
operationId: getRequestV2
summary: Retrieve a request
description: |
Retrieves the full representation of a specific request
You can use this endpoint to retrieve access requests managed by access request conditions.
More information is returned than the abbreviated representation in a List requests operation.
parameters:
- $ref: '#/components/parameters/rcar-request-id-parameter'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.request.read
responses:
'200':
$ref: '#/components/responses/request-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/requests/{requestId}/messages:
post:
x-okta-lifecycle:
lifecycle: GA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Requests
operationId: createRequestMessageV2
summary: Create a request message
description: |
Creates a message to add context to the Access requests using request conditions and sequences. The message appears in the **Requester** section of the Access Requests console, and the message is authored by the admin user ID calling the endpoint.
parameters:
- $ref: '#/components/parameters/rcar-request-id-parameter'
security:
- ApiKey:
- admin
- OAuth2:
- okta.accessRequests.request.manage
requestBody:
required: true
description: The writable attributes of a request message
content:
application/json:
schema:
$ref: '#/components/schemas/request-message-creatable'
examples:
ViewersAll:
$ref: '#/components/examples/request-message-00-create-message-audience-all'
ReferenceToAnotherSystem:
$ref: '#/components/examples/request-message-01-create-message-referencing-another-system'
MaxMessageLimit:
$ref: '#/components/examples/request-message-02-create-message-max-message-limit'
responses:
'201':
description: A successful create request message response
'401':
$ref: '#/components/responses/authentication-error-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/catalogs/default/entries:
get:
x-okta-lifecycle:
lifecycle: EA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Catalogs
operationId: listAllDefaultEntriesV2
parameters:
- $ref: '#/components/parameters/rcar-entries-list-filter-v2'
- $ref: '#/components/parameters/rcar-entries-list-after'
- $ref: '#/components/parameters/rcar-entries-list-match'
- $ref: '#/components/parameters/rcar-entries-list-limit'
summary: List all entries for the default access request catalog
description: |-
Lists entries for the default access request catalog based on a required `filter` query parameter.
The following are request examples with a filter expression. In each example, the filter expression includes the mandatory `parent` property.
1. Lists at most 20 parent (top-level) entries
```
/governance/api/v2/catalogs/default/entries?filter=not(parent%20pr)&limit=20
```
1. Lists the next 20 results of parent entries after a specific cursor
```
/governance/api/v2/catalogs/default/entries?filter=not(parent%20pr)&limit=20&after=cen33e47frfMB93gQ8g6
```
1. Lists at most 8 parent entries with a fuzzy match for "figma"
```
/governance/api/v2/catalogs/default/entries?filter=not(parent%20pr)&match=figma&limit=8
```
1. Lists at most 8 child entries with a specific parent
```
/governance/api/v2/catalogs/default/entries?filter=parent%20eq%20%22cen385AlcdqGaY8HE0g2%22&limit=8
```
1. Lists at most 8 child entries that have "edit" in the name and have a specific parent
```
/governance/api/v2/catalogs/default/entries?filter=parent%20eq%20%22cen385AlcdqGaY8HE0g2%22&match=edit&limit=8
```
security:
- OAuth2:
- okta.accessRequests.catalog.read
responses:
'200':
$ref: '#/components/responses/catalog-entries-list-success-v2'
'400':
$ref: '#/components/responses/rcar-entries-list-bad-request'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/catalogs/default/entries/{entryId}:
get:
x-okta-lifecycle:
lifecycle: EA
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Catalogs
operationId: getCatalogEntryV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
summary: Retrieve a catalog entry
description: Retrieves a catalog entry
security:
- OAuth2:
- okta.accessRequests.catalog.read
responses:
'200':
$ref: '#/components/responses/rcar-entry-get-success'
'400':
$ref: '#/components/responses/list-bad-request'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':
$ref: '#/components/responses/rate-limit-exceeded-response'
'500':
$ref: '#/components/responses/unexpected-error-response'
/governance/api/v2/catalogs/default/user/{userId}/entries:
get:
x-okta-iam-admin-roles:
- ACCESS_REQUESTS_ADMIN
tags:
- Catalogs
operationId: listAllDefaultUserEntriesV2
parameters:
- $ref: '#/components/parameters/user-id'
- $ref: '#/components/parameters/rcar-entries-list-filter-v2'
- $ref: '#/components/parameters/rcar-entries-list-after'
- $ref: '#/components/parameters/rcar-entries-list-match'
- $ref: '#/components/parameters/rcar-entries-list-limit'
summary: List all access request catalog entries for a user
description: |-
Lists access request catalog entries for a user based on a filter (the `filter` query parameter is required)
The following are request examples with query parameters:
1. Lists at most 20 parent (top-level) entries
```
/governance/api/v2/catalogs/default/user/{userId}/entries?filter=not(parent%20pr)&limit=20
```
1. Lists the next 20 results of parent entries after a specific cursor
```
/governance/api/v2/catalogs/default/user/{userId}/entries?filter=not(parent%20pr)&limit=20&after=cen33e47frfMB93gQ8g6
```
1. Lists at most 8 parent entries with a string match for "figma"
```
/governance/api/v2/catalogs/default/user/{userId}/entries?filter=not(parent%20pr)&match=figma&limit=8
```
1. Lists at most 8 child entries with a specific parent
```
/governance/api/v2/catalogs/default/user/{userId}/entries?filter=parent%20eq%20%22cen385AlcdqGaY8HE0g2%22&limit=8
```
1. Lists at most 8 child entries that have "edit" in the name and have a specific parent
```
/governance/api/v2/catalogs/default/user/{userId}/entries?filter=parent%20eq%20%22cen385AlcdqGaY8HE0g2%22&match=edit&limit=8
```
security:
- OAuth2:
- okta.accessRequests.catalog.read
responses:
'200':
$ref: '#/components/responses/catalog-entries-list-success-v2'
'400':
$ref: '#/components/responses/rcar-entries-list-bad-request'
'401':
$ref: '#/components/responses/authentication-error-response'
'403':
$ref: '#/components/responses/authorization-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
'429':