-
Notifications
You must be signed in to change notification settings - Fork 22
Expand file tree
/
Copy pathgovernance-production-enduser-reference-noEnums-minimal.yaml
More file actions
8370 lines (8299 loc) · 324 KB
/
Copy pathgovernance-production-enduser-reference-noEnums-minimal.yaml
File metadata and controls
8370 lines (8299 loc) · 324 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: Okta Enduser Governance API
description: Allows customers to easily access the Okta Governance API as an enduser
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: My Requests
description: |
Okta Access Requests automate the process of requesting access to applications and resources.
Endusers may request entries in their resource catalog.
Manage this process directly with the following request APIs.
See [Access Requests](https://help.okta.com/okta_help.htm?type=oie&id=ext-ar) for more information on Access Requests and Identity Governance.
x-okta-lifecycle:
lifecycle: GA
- name: My 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 My Catalogs API to request for catalog entries that you're allowed to request. 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: My Tasks
description: |
<x-lifecycle class="beta"></x-lifecycle>
The My Tasks API allows end users to retrieve tasks assigned to them from access requests made through access request conditions in your Okta Identity Governance (OIG) org.
x-okta-lifecycle:
lifecycle: BETA
- name: My Security Access Reviews
description: |
The My Security Access Reviews API allows reviewers to manage security access reviews that are assigned to them. These reviews provide a holistic view of a target principal's access to resources such as apps, groups, and entitlements. They're typically triggered as a response to a security or an identiy risk event. Reviewers can assess the target principal's access to resources and take immediate action.
The resource methods in the My Security Access Reviews API only returns security access reviews and corresponding objects that the authenticated requester (as the reviewer) has permission to access.
x-okta-lifecycle:
lifecycle: EA
- name: My Access Certification Reviews
description: |
The My Access Certification Reviews API enables end users to retrieve reviews and associated review resources that are assigned to them. The response is specifically for the authenticated user (the end user) making the request.
x-okta-lifecycle:
lifecycle: BETA
- name: My Settings
description: The My Settings API allows end users to manage their governance settings. The response is specifically for the authenticated user (the end user) making the request. Use this API to view and manage your settings, such as appointing a delegate for governance reviews.
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/my/catalogs/default/entries:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Catalogs
operationId: listMyDefaultEntriesV2
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 my entries for the default access request catalog
description: |-
Lists the filtered entries for the default access request catalog that you're allowed to request (as the authenticated requester).
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/rcar-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/my/catalogs/default/entries/{entryId}:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Catalogs
operationId: getMyEntryV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
summary: Retrieve my catalog entry
description: Retrieves an entry from my catalog
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/my/catalogs/default/entries/{entryId}/requests:
post:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
operationId: createMyRequestV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
tags:
- My Requests
summary: Create a request
description: Creates a request for my catalog entry specified by `entryId`
requestBody:
required: true
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.
content:
application/json:
schema:
$ref: '#/components/schemas/my-request-creatable'
examples:
WhenEntryHasNoRequesterFieldsEmptyObject:
$ref: '#/components/examples/request-00-create-no-fields-example'
WhenEntryHasNoRequesterFieldsRequesterFieldValuesEmptyArray:
$ref: '#/components/examples/request-01-create-no-fields-empty-array-example'
WhenEntryHasTextRequesterField:
$ref: '#/components/examples/request-02-create-text-field-required-example'
WhenEntryHasSelectRequesterField:
$ref: '#/components/examples/request-03-create-select-field-required-example'
WhenEntryHasMultiSelectRequesterField:
$ref: '#/components/examples/request-04-create-multi-select-field-required-example'
WhenEntryHasDatetimeRequesterField:
$ref: '#/components/examples/request-05-create-date-time-field-required-example'
WhenEntryHasAllFieldTypes:
$ref: '#/components/examples/request-06-create-one-field-of-each-type-required-example'
WhenEntryHasRequestOnBehalfOf:
$ref: '#/components/examples/request-07-create-request-on-behalf-of-required-example'
security:
- OAuth2:
- okta.accessRequests.request.manage
responses:
'202':
$ref: '#/components/responses/my-request-create-success-response'
'400':
$ref: '#/components/responses/my-request-create-bad-request-response'
'401':
$ref: '#/components/responses/authentication-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
/governance/api/v2/my/catalogs/default/entries/{entryId}/requests/{requestId}:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
operationId: getMyRequestV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
- $ref: '#/components/parameters/rcar-request-id-parameter'
tags:
- My Requests
summary: Retrieve my request
description: Retrieves a request belonging to the authenticated requester
security:
- OAuth2:
- okta.accessRequests.request.read
responses:
'200':
$ref: '#/components/responses/request-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
/governance/api/v2/my/catalogs/default/entries/{entryId}/request-fields:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
operationId: getMyCatalogEntryRequestFieldsV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
tags:
- My Catalogs
summary: Retrieve the request fields for my catalog entry
description: |
Retrieves request fields for a catalog entry that you're allowed to request (as the authenticated requester):
* Request fields are determined by evaluating the entry's associated request conditions for the requester.
* The highest priority matching condition determines the approval sequence that's used for the requester.
* If that approval sequence has requester fields, then they are returned as request fields.
* If the request can lead to any separation of duty conflicts, then the risk assessment (`metadata.riskAssessment`) is present. The risk assessment indicates whether the request submission is allowed or restricted, and includes rules that lead to the possible conflicts. If the request submission is allowed, then the request fields are determined by the associated approval sequence.
security:
- OAuth2:
- okta.accessRequests.request.read
responses:
'200':
$ref: '#/components/responses/my-request-fields-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
/governance/api/v2/my/catalogs/default/entries/{entryId}/users:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Catalogs
operationId: listMyEntryUsersV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
- $ref: '#/components/parameters/entry-user-list-filter'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/limit'
summary: List my catalog entry users
description: |
Lists all users who match the filtered query and can also view and request the entry.
The `filter` query parameter is mandatory for this operation. A list of users is returned if:
* the entry has the `requestOnBehalfOfSettings` enabled
* the authorized user is able to request on behalf of other users
**Examples**
Request examples:
1. Filter users with a last name that starts with "Smi"
```
/governance/api/v2/my/catalogs/default/entries/{entryId}/users?filter=lastName%20sw%20%22Smi%22
```
1. Filter for users with a first name that begins with "John"
```
/governance/api/v2/my/catalogs/default/entries/{entryId}/users?filter=firstName%20sw%20%22John%22
```
1. Search for users with a first or last name that begins with "John"
```
/governance/api/v2/my/catalogs/default/entries/{entryId}/users?filter=firstName%20sw%20%22John%22%20OR%20lastName%20sw%20%22John%22
```
security:
- OAuth2:
- okta.accessRequests.catalog.read
responses:
'200':
$ref: '#/components/responses/entry-users-list-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/my/catalogs/default/entries/{entryId}/users/{userId}/request-fields:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Catalogs
operationId: getMyCatalogEntryUserRequestFieldsV2
parameters:
- $ref: '#/components/parameters/catalog-entry-id'
- $ref: '#/components/parameters/user-id'
summary: Retrieve the entry request fields for a user
description: |
Retrieves the entry's request fields for the specified requester.
Request fields for the entry are only returned if the entry has "request on behalf of" (`requestOnBehalfOfSettings`) enabled, and the authorized user is able to request on behalf of other requesters.
If the request can lead to any separation of duty conflicts, then the risk assessment (`metadata.riskAssessment`) is returned.
The risk assessment indicates whether the request submission is allowed or restricted, and includes rules that lead to the possible conflicts.
If the request submission is allowed, then the request fields are determined by the associated approval sequence for the risk level.
security:
- OAuth2:
- okta.accessRequests.catalog.read
responses:
'200':
$ref: '#/components/responses/my-request-fields-get-success'
'401':
$ref: '#/components/responses/authentication-error-response'
'404':
$ref: '#/components/responses/resource-not-found-response'
/governance/api/v2/my/tasks:
get:
x-okta-lifecycle:
lifecycle: BETA
tags:
- My Tasks
x-disable-permissions-audit: true
operationId: listAllMyTasksV2
summary: List all my tasks
description: |
Lists all tasks assigned to you from access requests managed by OIG access request conditions.
See [Access request conditions](https://help.okta.com/okta_help.htm?type=oie&id=csh-rcar-conditions) in the product documentation.
parameters:
- $ref: '#/components/parameters/my-task-list-filter'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/task-list-after'
- $ref: '#/components/parameters/task-list-order-by'
security:
- OAuth2:
- okta.accessRequests.tasks.read
responses:
'200':
$ref: '#/components/responses/my-tasks-list-success'
'400':
$ref: '#/components/responses/my-tasks-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'
/governance/api/v2/my/tasks/{taskId}:
get:
x-okta-lifecycle:
lifecycle: BETA
tags:
- My Tasks
x-disable-permissions-audit: true
operationId: getMyTaskV2
summary: Retrieve my task
description: |
Retrieves the details of a task that's assigned to you.
You can only retrieve a task from an access request that's managed by access request conditions.
See [Access request conditions](https://help.okta.com/okta_help.htm?type=oie&id=csh-rcar-conditions) for more information on Access request conditions and Identity Governance.
parameters:
- $ref: '#/components/parameters/task-id-parameter'
security:
- OAuth2:
- okta.accessRequests.tasks.read
responses:
'200':
$ref: '#/components/responses/my-task-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/my/tasks/{taskId}/resolve:
post:
x-okta-lifecycle:
lifecycle: BETA
tags:
- My Tasks
x-disable-permissions-audit: true
operationId: resolveMyTaskV2
summary: Resolve my task
description: |
Resolves a task that's assigned to you (the current authenticated user)
parameters:
- $ref: '#/components/parameters/task-id-parameter'
security:
- OAuth2:
- okta.accessRequests.tasks.manage
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
value:
type: string
description: |
Specify the task resolution value. Required for `APPROVAL` and `QUESTION` type tasks.
* For `APPROVAL` type tasks, the only supported values are `APPROVED` or `DENIED`.
* For `QUESTION` type tasks, the value is the answer to the question, and can be any string.
* For custom `TODO` type tasks, you don't need to specify a resolution value.
examples:
ApproveTaskResolution:
summary: Approve my task
description: Only applicable for `APPROVAL` type tasks
value:
value: APPROVED
DenyTaskResolution:
summary: Deny my task
description: Only applicable for `APPROVAL` type tasks
value:
value: DENIED
QuestionTaskResolution:
summary: Answer my question
description: Only applicable for `QUESTION` type tasks
value:
value: Answer to the question
CustomTaskResolution:
summary: Mark my custom task complete
description: Request body not required for custom tasks
value: {}
responses:
'200':
$ref: '#/components/responses/my-task-resolve-success'
'400':
$ref: '#/components/responses/task-resolve-failed'
'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/my/security-access-reviews:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: listMySecurityAccessReviews
summary: List the security access reviews
description: Lists the security access reviews
parameters:
- $ref: '#/components/parameters/security-access-reviews-filter'
- $ref: '#/components/parameters/security-access-reviews-order-by'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/limit'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-reviews-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/my/security-access-reviews/stats:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: getMySecurityAccessReviewsStats
summary: Retrieve the statistics for security access reviews
description: Retrieves the statistics for security access reviews
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-reviews-stats-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/my/security-access-reviews/{securityAccessReviewId}:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: getMySecurityAccessReview
summary: Retrieve a security access review
description: Retrieves a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-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/my/security-access-reviews/{securityAccessReviewId}/summary:
post:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: generateMySecurityAccessReviewSummary
summary: Generate a summary for a security access review
description: |-
Generates a summary for a security access review
> **Note:** The [`governanceAI.securityAccessReview.enabled`](https://developer.okta.com/docs/api/iga/openapi/governance.api/tag/Org-Governance-Settings/#tag/Org-Governance-Settings/operation/updateOrgSettings!path=governanceAI&t=request) org governance setting must be enabled for users to generate summaries for security access reviews.
parameters:
- $ref: '#/components/parameters/security-access-review-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.manage
responses:
'200':
$ref: '#/components/responses/security-access-review-generate-summary-post-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/my/security-access-reviews/{securityAccessReviewId}/actions:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: listMySecurityAccessReviewActions
summary: List all actions for a security access review
description: Lists all of the actions available for a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-actions-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-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: executeMySecurityAccessReviewAction
summary: Execute an action on a security access review
description: Executes a specified action on a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/security-access-review-action-request'
responses:
'202':
description: Action initiated successfully
'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/my/security-access-reviews/{securityAccessReviewId}/principal:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: getMySecurityAccessReviewPrincipalDetails
summary: Retrieve the principal for a security access review
description: Retrieves the details of a security access review's principal target
parameters:
- $ref: '#/components/parameters/security-access-review-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-principal-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/my/security-access-reviews/{securityAccessReviewId}/accesses:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: listMySecurityAccessReviewAccesses
summary: List the access items for a security access review
description: |-
Lists the access items for a specific security access review.
Access items refer to the top-level resources that the security access review's target principal has access to.
For example, a top-level resource can be an app, hence the access item describes the principal's access to that app.
parameters:
- $ref: '#/components/parameters/security-access-review-id'
- $ref: '#/components/parameters/security-access-review-accesses-filter'
- $ref: '#/components/parameters/security-access-review-accesses-order-by'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/limit'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-access-items-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/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: listMySecurityAccessReviewSubAccesses
summary: List the sub-access items for an access item
description: |-
Lists the sub-access items for an access item from a security access review.
A sub-access item refers to the access of a resource that is a part of a top-level resource in an access item.
For example, an access item can describe the access of app, and the sub-access items can describe the access of groups, entitlement values, or entitlement bundles that belong to the app.
parameters:
- $ref: '#/components/parameters/security-access-review-id'
- $ref: '#/components/parameters/security-access-review-access-id'
- $ref: '#/components/parameters/security-access-review-sub-accesses-filter'
- $ref: '#/components/parameters/security-access-review-sub-accesses-order-by'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/limit'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-sub-access-items-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/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: listMySecurityAccessReviewAccessesAnomalies
summary: List the anomalies for an access item
description: Lists the anomalies for an access item in a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
- $ref: '#/components/parameters/security-access-review-target-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-anomalies-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/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary:
post:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: generateMySecurityAccessReviewAccessesSummary
summary: Generate a summary for an access item
description: |-
Generates a summary for an access item in a security access review
> **Note:** The [`governanceAI.securityAccessReview.enabled`](https://developer.okta.com/docs/api/iga/openapi/governance.api/tag/Org-Governance-Settings/#tag/Org-Governance-Settings/operation/updateOrgSettings!path=governanceAI&t=request) org governance setting must be enabled for users to generate summaries for security access reviews.
parameters:
- $ref: '#/components/parameters/security-access-review-id'
- $ref: '#/components/parameters/security-access-review-target-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.manage
responses:
'200':
$ref: '#/components/responses/security-access-review-generate-summary-post-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/my/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions:
post:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: executeMySecurityAccessReviewAccessesAction
summary: Execute an action on an access item
description: Executes an action on an access or sub-access item in a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
- $ref: '#/components/parameters/security-access-review-target-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/security-access-review-accesses-action-request'
responses:
'202':
description: Action initiated successfully
'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/my/security-access-reviews/{securityAccessReviewId}/history:
get:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: listMySecurityAccessReviewHistory
summary: List the history of a security access review
description: Lists the history of actions and changes for a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/limit'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.read
responses:
'200':
$ref: '#/components/responses/security-access-review-history-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/my/security-access-reviews/{securityAccessReviewId}/comment:
post:
x-okta-lifecycle:
lifecycle: GA
x-disable-permissions-audit: true
tags:
- My Security Access Reviews
operationId: addMySecurityAccessReviewComment
summary: Add a comment for a security access review
description: Adds a comment for a security access review
parameters:
- $ref: '#/components/parameters/security-access-review-id'
security:
- OAuth2:
- okta.governance.securityAccessReviews.endUser.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/security-access-review-comment-request'
responses:
'204':
description: Comment added successfully
'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/v1/my/settings:
get:
x-okta-lifecycle:
lifecycle: BETA
x-disable-permissions-audit: true
tags:
- My Settings
operationId: getMySettings
summary: Retrieve my settings
description: Retrieves the settings for the current authenticated user
security:
- OAuth2:
- okta.governance.principalSettings.read
responses:
'200':
$ref: '#/components/responses/my-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: BETA
x-disable-permissions-audit: true
tags:
- My Settings
operationId: updateMySettings
summary: Update my settings
description: Updates the settings for the current authenticated user
security:
- OAuth2:
- okta.governance.principalSettings.manage
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/my-settings-patchable'
examples:
UpdateMySettingsWithSelfAppointedDelegate:
$ref: '#/components/examples/my-settings-with-self-appointed-delegate'
UpdateMySettingsNoDelegate:
$ref: '#/components/examples/settings-with-no-delegate'
responses:
'200':
$ref: '#/components/responses/my-settings-patch-success'
'400':
$ref: '#/components/responses/settings-patch-bad-request-response'
'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/v1/my/settings/delegate/users:
get:
x-okta-lifecycle:
lifecycle: BETA
x-disable-permissions-audit: true
tags:
- My Settings
operationId: listMyDelegateUsers
parameters:
- $ref: '#/components/parameters/delegates-user-list-filter'
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/limit'
summary: List my eligible delegates
description: |
Lists the users who are eligible delegates for the current authenticated user.
The `filter` query parameter is optional when the org's delegate scope is restricted (the `onlyFor` list contains MANAGER or both MANAGER and PEERS).
When omitted in this case, the endpoint returns all eligible delegates.