-
Notifications
You must be signed in to change notification settings - Fork 19
/
idp-noEnums-oneOfInheritance-noExamples.yaml
3657 lines (3633 loc) · 131 KB
/
idp-noEnums-oneOfInheritance-noExamples.yaml
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: MyAccount Management
version: 2024.08.3
description: |-
APIs for managing a user's own emails, phones, profile, and app authenticators.
> **Note:** The MyAccount API doesn't support [delegated authentication](https://help.okta.com/okta_help.htm?id=ext_Security_Authentication).
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
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 an official Okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains.
tags:
- name: AppAuthenticator
x-displayName: App Authenticators
description: |
The MyAccount App Authenticators API provides operations to enroll, update, and delete an app authenticator. The API also allows users to view and verify pending notification challenges. The API only supports custom authenticators. See the [Custom authenticator integration guide](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/).
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: false
SKUs: []
- name: Authenticators
description: |
<div class="x-lifecycle-container"><x-lifecycle class="lea"></x-lifecycle> <x-lifecycle class="oie"></x-lifecycle></div>The MyAccount Authenticators API provides operations to list all available authenticators and enrollments.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
- name: Email
description: |
The MyAccount Email API provides operations to enroll, update, and delete emails. The API also provides utilities to create, view, and answer verification challenges.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
- name: OktaApplications
x-displayName: Okta Applications
description: |
<div class="x-lifecycle-container"><x-lifecycle class="lea"></x-lifecycle> <x-lifecycle class="oie"></x-lifecycle></div>The MyAccount Profile API provides operations to view the Okta apps list. Okta creates and maintains Okta apps, or first-party apps, for example, the Admin Console and End-User Dashboard.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
- name: Organization
description: |
<div class="x-lifecycle-container"><x-lifecycle class="lea"></x-lifecycle> <x-lifecycle class="oie"></x-lifecycle></div>The MyAccount Profile API provides operations to view Org details.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
- name: Password
description: |
The MyAccount Password API provides operations to enroll, update, and delete passwords.
> **Note:** Super admins can enable the IDP MyAccount API Password feature. See [Manage Early Access and Beta features](https://help.okta.com/okta_help.htm?type=oie&id=ext_secur_manage_ea_bata).
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
- name: Phone
description: |
The MyAccount Phone API provides operations to enroll, update, and delete phone numbers. The API also provides utilities to create, view, and answer verification challenges.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
- name: Profile
description: |
The MyAccount Profile API provides operations to enroll and update profile fields. The API also allows viewing of all allowed profile fields.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
- name: Sessions
x-displayName: Sessions
description: |
<div class="x-lifecycle-container"><x-lifecycle class="lea"></x-lifecycle> <x-lifecycle class="oie"></x-lifecycle></div>The MyAccount Sessions API provides operations to manage sessions.
See [Sessions](/openapi/okta-management/management/tag/Session/) for more information.
### API versioning
A valid API version in the `Accept` header is required to access the API. Current version: `1.0.0`
```json
Accept: application/json; okta-version=1.0.0
```
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
externalDocs:
description: Find more info here
url: https://developer.okta.com
paths:
/idp/myaccount/app-authenticators:
post:
summary: Create an app authenticator enrollment
description: Creates an app authenticator enrollment
operationId: createAppAuthenticatorEnrollment
requestBody:
content:
application/json, okta-version=1.0.0:
schema:
$ref: '#/components/schemas/AppAuthenticatorEnrollmentRequest'
examples:
Create-App-Authenticator-Enrollment:
$ref: '#/components/examples/CreateAppAuthenticatorEnrollment'
responses:
'200':
description: OK
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/AppAuthenticatorEnrollment'
'400':
description: Bad Request
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Unauthorized
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Access Denied
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Resource Not Found
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2:
- okta.myAccount.appAuthenticator.manage
tags:
- AppAuthenticator
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
/idp/myaccount/app-authenticators/challenge/{challengeId}/verify:
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
parameters:
- $ref: '#/components/parameters/appAuthenticatorChallengeId'
post:
summary: Verify a push notification challenge response from the app authenticator
description: Verifies a push notification challenge from the app authenticator
operationId: verifyAppAuthenticatorPushNotificationChallenge
requestBody:
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/PushNotificationVerification'
examples:
PushNotificationChallengeRequestEx:
$ref: '#/components/examples/VerifyPushNotificationChallengeRequest'
PushNotificationChallengeRequestJWTHeaderEx:
$ref: '#/components/examples/VerifyPushNotificationChallengeJWTHeader'
PushNotificationChallengeRequestJWTPayloadEx:
$ref: '#/components/examples/VerifyPushNotificationChallengeJWTPayload'
responses:
'200':
description: Verification Success
'204':
description: User denied challenge attempt
'400':
description: Bad Request
security: []
tags:
- AppAuthenticator
/idp/myaccount/app-authenticators/{enrollmentId}:
parameters:
- $ref: '#/components/parameters/appAuthenticatorEnrollmentId'
patch:
summary: Update an app authenticator enrollment
description: |-
Updates an app authenticator enrollment
The following update operations are allowed:
* Update the user verification key
* Remove the user verification key
* Update the push token
* Update the push method transaction types
For more information, see [Access token management](https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/#access-token-management) in the Custom authenticator integration guide.
> **Note:** The following higher risk update operations require a stronger `okta.myAccount.appAuthenticator.manage` scope:
> * Update the user verification key
> * Remove the user verification key
operationId: updateAppAuthenticatorEnrollment
requestBody:
content:
application/merge-patch+json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/UpdateAppAuthenticatorEnrollmentRequest'
examples:
UpdateAppAuthenticatorEnrollmentPushTokenEx:
$ref: '#/components/examples/UpdateAppAuthenticatorEnrollmentPushToken'
EnrollAppAuthenticatorEnrollmentUserVerificationKeyEx:
$ref: '#/components/examples/UpdateAppAuthenticatorEnrollmentUserVerificationKey'
UnenrollAppAuthenticatorEnrollmentUserVerificationKeyEx:
$ref: '#/components/examples/UnenrollAppAuthenticatorEnrollmentUserVerificationKey'
UpdateAppAuthenticatorEnrollmentTransactionTypeEx:
$ref: '#/components/examples/UpdateAppAuthenticatorEnrollmentTransactionType'
UpdateAppAuthenticatorEnrollmentPushTokenandEnrollUserVerificationKeyEx:
$ref: '#/components/examples/UpdateAppAuthenticatorEnrollmentPushTokenAndUserVerificationKey'
responses:
'200':
description: OK
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/AppAuthenticatorEnrollment'
'401':
description: Unauthorized
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Access Denied
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Resource Not Found
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2:
- okta.myAccount.appAuthenticator.maintenance.manage
tags:
- AppAuthenticator
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
delete:
summary: Delete an app authenticator enrollment
description: Deletes an app authenticator enrollment
operationId: deleteAppAuthenticatorEnrollment
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Access Denied
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Resource Not Found
content:
application/json;okta-version=1.0.0:
schema:
$ref: '#/components/schemas/Error'
security:
- oauth2:
- okta.myAccount.appAuthenticator.manage
tags:
- AppAuthenticator
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
/idp/myaccount/app-authenticators/{enrollmentId}/push/notifications:
parameters:
- $ref: '#/components/parameters/appAuthenticatorEnrollmentId'
get:
summary: List all pending push notification challenges
description: Lists all pending push notification challenges
operationId: listAppAuthenticatorPendingPushNotificationChallenges
responses:
'200':
description: Success
content:
application/json;okta-version=1.0.0:
schema:
type: array
items:
$ref: '#/components/schemas/PushNotificationChallenge'
examples:
SuccessResponseEx:
$ref: '#/components/examples/GetPendingNotificationsSuccessResponse'
JWTHeaderEx:
$ref: '#/components/examples/GetPendingNotificationsJWTHeader'
JWTPayloadEx:
$ref: '#/components/examples/GetPendingNotificationsJWTPayload'
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
security:
- oauth2:
- okta.myAccount.appAuthenticator.maintenance.read
tags:
- AppAuthenticator
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
/idp/myaccount/authenticators:
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
get:
summary: List all Authenticators
description: |
Lists all of the authenticators for the current user
operationId: listAuthenticators
parameters:
- $ref: '#/components/parameters/queryExpandAuthenticator'
responses:
'200':
$ref: '#/components/responses/ListAuthenticatorsResponse'
'403':
$ref: '#/components/responses/ErrorAccessDenied403'
'429':
$ref: '#/components/responses/ErrorTooManyRequests429'
security:
- oauth2:
- okta.myAccount.authenticators.read
tags:
- Authenticators
/idp/myaccount/authenticators/{authenticatorId}:
parameters:
- $ref: '#/components/parameters/pathAuthenticatorId'
get:
summary: Retrieve an Authenticator
description: |
Retrieves an Authenticator by `authenticatorId`
operationId: getAuthenticator
parameters:
- $ref: '#/components/parameters/queryExpandAuthenticator'
responses:
'200':
$ref: '#/components/responses/AuthenticatorResponse'
'403':
$ref: '#/components/responses/ErrorAccessDenied403'
'404':
$ref: '#/components/responses/ErrorResourceNotFound404'
'429':
$ref: '#/components/responses/ErrorTooManyRequests429'
security:
- oauth2:
- okta.myAccount.authenticators.read
tags:
- Authenticators
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
/idp/myaccount/authenticators/{authenticatorId}/enrollments:
parameters:
- $ref: '#/components/parameters/pathAuthenticatorId'
get:
summary: List all Enrollments
description: |
Lists all Enrollments the current user has for an authenticator
operationId: listEnrollments
responses:
'200':
$ref: '#/components/responses/ListEnrollmentsResponse'
'403':
$ref: '#/components/responses/ErrorAccessDenied403'
'404':
$ref: '#/components/responses/ErrorResourceNotFound404'
'429':
$ref: '#/components/responses/ErrorTooManyRequests429'
security:
- oauth2:
- okta.myAccount.authenticators.read
tags:
- Authenticators
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}:
parameters:
- $ref: '#/components/parameters/pathAuthenticatorId'
- $ref: '#/components/parameters/pathEnrollmentId'
get:
summary: Retrieve an Enrollment
description: |
Retrieves an Enrollment by `enrollmentId`
operationId: getEnrollment
responses:
'200':
$ref: '#/components/responses/EnrollmentResponse'
'403':
$ref: '#/components/responses/ErrorAccessDenied403'
'404':
$ref: '#/components/responses/ErrorResourceNotFound404'
'429':
$ref: '#/components/responses/ErrorTooManyRequests429'
security:
- oauth2:
- okta.myAccount.authenticators.read
tags:
- Authenticators
x-okta-lifecycle:
lifecycle: LIMITED_GA
isGenerallyAvailable: false
SKUs:
- Okta Identity Engine
/idp/myaccount/emails:
get:
summary: List all Emails
description: |
Lists all of the current user's email information: a collection of links for each email that describe the acceptable operations
operationId: listEmails
responses:
'200':
$ref: '#/components/responses/Email-Array-Response'
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
security:
- oauth2:
- okta.myAccount.email.read
tags:
- Email
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: true
post:
summary: Create an Email
description: |
Creates a primary or secondary email address for the user's account. The new email address has an `UNVERIFIED` status.
operationId: createEmail
requestBody:
content:
application/json:
schema:
type: object
properties:
profile:
type: object
description: Defines the email address on the profile
required:
- email
properties:
email:
type: string
example: saml.jackson@example.com
format: email
writeOnly: true
sendEmail:
type: boolean
default: true
description: Specifies whether Okta or the application sends an email to the end user
state:
type: string
example: JPcFLTwOq7UvoFtmRd3EnyQwsR0PbDSI
description: |
Any application state that the client wishes to persist across the email challenge flow, and receive at the callback URL. Define the callback URL in the OIDC app configuration. This parameter proves to the client that the email link is verified.
writeOnly: true
role:
type: string
enum:
- PRIMARY
- SECONDARY
example: PRIMARY
writeOnly: true
required:
- profile
description: New email
responses:
'201':
$ref: '#/components/responses/Unverified-Email-Response'
'400':
$ref: '#/components/responses/Error-InvalidEmail-Response-400'
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
'403':
$ref: '#/components/responses/Error-Email-Response-403'
'409':
$ref: '#/components/responses/Error-EmailConflict-Response-409'
security:
- oauth2:
- okta.myAccount.email.manage
tags:
- Email
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: true
/idp/myaccount/emails/{id}:
parameters:
- schema:
type: string
example: 69dca29c2d8dbb0dca14395ccdb92317
description: |
The email ID
Use `GET /idp/myaccount/emails` or `POST /idp/myaccount/emails` operations to obtain the email ID when adding a new email address.
name: id
in: path
required: true
get:
summary: Retrieve an Email
description: 'Retrieves the current user''s email information by ID: a collection of links that describe the acceptable email operations'
operationId: getEmail
responses:
'200':
$ref: '#/components/responses/Verified-Email-Response'
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
security:
- oauth2:
- okta.myAccount.email.read
tags:
- Email
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: true
delete:
summary: Delete an Email
description: |
Deletes the current user's email information by ID. You can only delete unverified primary and secondary emails.
operationId: deleteEmail
parameters: []
responses:
'204':
description: No Content
content:
application/json;okta-version=1.0.0: {}
'400':
$ref: '#/components/responses/Error-InvalidEmailDeletion-400'
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
'404':
$ref: '#/components/responses/Error-EmailResourceNotFound-Response-404'
security:
- oauth2:
- okta.myAccount.email.manage
tags:
- Email
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: true
/idp/myaccount/emails/{id}/challenge:
parameters:
- schema:
type: string
example: 00T196qTp3LIMZQ0L0g3
description: |-
The email ID
Use the `GET /idp/myaccount/emails` or `POST /idp/myaccount/emails` operations when adding a new email address.
name: id
in: path
required: true
post:
summary: Send an Email Challenge
description: |-
Sends a \"Confirm email address change\" email to the user with a one-time passcode for verification.
Also, the user receives a \"Notice of pending email address change\" email. After the challenge is verified, the email becomes active.
operationId: sendEmailChallenge
requestBody:
content:
application/json:
schema:
type: object
properties:
state:
type: string
example: JPcFLTwOq7UvoFtmRd3EnyQwsR0PbDSI
writeOnly: true
description: (Optional) The state parameter that contains the state of the client
required:
- state
responses:
'201':
description: Created
headers: {}
content:
application/json;okta-version=1.0.0:
schema:
type: object
example:
id: myaccount.2wdtXPtmS0WpKq4bnjlYIw
status: UNVERIFIED
expiresAt: '2022-02-01T00:19:08.220Z'
profile:
email: s.jackson@example.com
_links:
verify:
href: https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.2wdtXPtmS0WpKq4bnjlYIw/verify
hints:
allow:
- POST
poll:
href: https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.2wdtXPtmS0WpKq4bnjlYIw
hints:
allow:
- GET
properties:
id:
type: string
description: The email ID of the caller
minLength: 1
status:
type: string
description: The challenge status of the caller's email
enum:
- VERIFIED
- UNVERIFIED
minLength: 1
expiresAt:
type: string
description: The time when the challenge expires. A challenge has a lifetime of five minutes.
minLength: 1
profile:
type: object
description: Defines the email address on the profile
required:
- email
properties:
email:
type: string
description: The email address on the profile
minLength: 1
_links:
type: object
description: Discoverable resources related to the caller's email challenge
required:
- verify
- poll
properties:
verify:
type: object
description: Link to the resource (verify)
required:
- href
- hints
properties:
href:
type: string
description: Link URI
minLength: 1
hints:
type: object
description: Describes the allowed HTTP verbs for the `href`
required:
- allow
properties:
allow:
type: array
items:
type: string
enum:
- POST
poll:
type: object
description: Link to the resource (poll)
required:
- href
- hints
properties:
href:
type: string
description: Link URI
minLength: 1
hints:
type: object
description: Describes the allowed HTTP verbs for the `href`
required:
- allow
properties:
allow:
type: array
items:
type: string
enum:
- GET
required:
- id
- status
- expiresAt
- profile
- _links
examples:
Challenge-Created-Response:
value:
id: myaccount.2wdtXPtmS0WpKq4bnjlYIw
status: UNVERIFIED
expiresAt: '2022-02-01T00:19:08.220Z'
profile:
email: s.jackson@example.com
_links:
verify:
href: https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.2wdtXPtmS0WpKq4bnjlYIw/verify
hints:
allow:
- POST
poll:
href: https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.2wdtXPtmS0WpKq4bnjlYIw
hints:
allow:
- GET
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
'403':
$ref: '#/components/responses/Error-Email-Response-403'
'404':
$ref: '#/components/responses/Error-EmailResourceNotFound-Response-404'
security:
- oauth2:
- okta.myAccount.email.manage
tags:
- Email
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: true
/idp/myaccount/emails/{id}/challenge/{challengeId}:
parameters:
- schema:
type: string
example: 00T196qTp3LIMZQ0L0g3
description: |-
The email ID
Use the `GET /idp/myaccount/emails` or `POST /idp/myaccount/emails` operations to obtain the ID when adding a new email address.
name: id
in: path
required: true
- schema:
type: string
example: x1MDGzUb
name: challengeId
description: |-
The `challengeId` of the email
Use the `POST /idp/myaccount/emails/{id}/challenge/` operation to obtain the `challengeId` when creating a new challenge.
in: path
required: true
get:
summary: Poll the Challenge for Email Magic Link
description: Polls for the email challenge's status
operationId: pollChallengeForEmailMagicLink
responses:
'200':
description: OK
content:
application/json;okta-version=1.0.0:
schema:
description: ''
type: object
example:
id: myaccount.DDvNA6XORA2dIfB894o32g
status: UNVERIFIED
expiresAt: '2022-02-01T00:41:25.497Z'
profile:
email: s.jackson@example.com
_links:
verify:
href: https://example.okta.com/idp/myaccount/emails/da03e945d44d8b714da2b9fded39e851/challenge/myaccount.DDvNA6XORA2dIfB894o32g/verify
hints:
allow:
- POST
poll:
href: https://example.okta.com/idp/myaccount/emails/da03e945d44d8b714da2b9fded39e851/challenge/myaccount.DDvNA6XORA2dIfB894o32g
hints:
allow:
- GET
properties:
id:
type: string
description: The email ID
minLength: 1
status:
type: string
description: The challenge status of the caller's email
minLength: 1
enum:
- VERIFIED
- UNVERIFIED
expiresAt:
type: string
description: The time at which the challenge expires. The lifetime of a challenge is five minutes.
minLength: 1
profile:
type: object
description: Defines the email address on the profile
required:
- email
properties:
email:
type: string
description: The email address on the profile
minLength: 1
_links:
type: object
description: Discoverable resources related to the poll for the email challenge's status
required:
- verify
- poll
properties:
verify:
type: object
description: Link to the resource (verify)
required:
- href
- hints
properties:
href:
type: string
description: Link URI
minLength: 1
hints:
type: object
description: Describes the allowed HTTP verbs for the `href`
required:
- allow
properties:
allow:
type: array
items:
type: string
enum:
- DELETE
- GET
- POST
- PUT
poll:
type: object
description: Link to the resource (poll)
required:
- href
- hints
properties:
href:
type: string
description: Link URI
minLength: 1
hints:
type: object
description: Describes the allowed HTTP verbs for the `href`
required:
- allow
properties:
allow:
type: array
items:
type: string
enum:
- DELETE
- GET
- POST
- PUT
required:
- id
- status
- expiresAt
- profile
- _links
examples:
Polling-Response-Example:
value:
id: myaccount.DDvNA6XORA2dIfB894o32g
status: UNVERIFIED
expiresAt: '2022-02-01T00:41:25.497Z'
profile:
email: s.jackson@example.com
_links:
verify:
href: https://example.okta.com/idp/myaccount/emails/da03e945d44d8b714da2b9fded39e851/challenge/myaccount.DDvNA6XORA2dIfB894o32g/verify
hints:
allow:
- POST
poll:
href: https://example.okta.com/idp/myaccount/emails/da03e945d44d8b714da2b9fded39e851/challenge/myaccount.DDvNA6XORA2dIfB894o32g
hints:
allow:
- GET
'401':
$ref: '#/components/responses/Error-IdpMyAccountNotEnabled-Response-401'
'404':
$ref: '#/components/responses/Error-EmailChallengeResourceNotFound-Response-404'
security:
- oauth2:
- okta.myAccount.email.read
tags:
- Email
x-okta-lifecycle:
lifecycle: GA
isGenerallyAvailable: true
/idp/myaccount/emails/{id}/challenge/{challengeId}/verify:
parameters:
- schema:
type: string
example: 00T196qTp3LIMZQ0L0g3
description: |
The email ID
Use `GET /idp/myaccount/emails` or `POST /idp/myaccount/emails` operations to obtain the email ID when adding a new email address.
name: id
in: path
required: true
- schema:
type: string
example: x1MDGzUb
description: |
The `challengeId` of the email
Use the `POST /idp/myaccount/emails/{id}/challenge` operation to obtain the `challengeId` when creating a new challenge.
name: challengeId
in: path
required: true
post:
summary: Verify an Email OTP
description: |
Verifies the email challenge with the code that the user receives from the \"Confirm email address change\" email. Once verified, the email is active.
operationId: verifyEmailOtp
requestBody:
content:
application/json:
schema:
type: object
properties:
verificationCode:
type: string
example: '498560'
format: password
writeOnly: true
description: A six-digit verification code sent to the user in the "Confirm email address change" email
required:
- verificationCode
responses: