{"items":[{"type":"link","label":"MyAccount Management","link":"/openapi/okta-myaccount/myaccount","routeSlug":"/openapi/okta-myaccount/myaccount","content":{"contentType":"overview","meta":{"name":"MyAccount Management"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"java","title":"Java","lang":"Java"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain of your organization. This can be an official Okta domain (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oktapreview.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or one of your configured custom domains."},"children":[]}]}]}]}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"MyAccount Management","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for managing a user's own emails, phones, profile, and app authenticators."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The MyAccount API doesn't support "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?id=ext_Security_Authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delegated authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"sectionId":"/openapi/okta-myaccount/myaccount"},{"nodeType":"external-docs","url":"https://developer.okta.com","description":"Find more info here"}],"sectionId":"/openapi/okta-myaccount/myaccount"}]}]}},{"type":"group","label":"App Authenticators","link":"/openapi/okta-myaccount/myaccount/appauthenticator","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/appauthenticator/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"appauthenticator/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"Create an App Authenticator Enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/createappauthenticatorenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/createappauthenticatorenrollment","metadata":{"seo":{"title":"Create an App Authenticator Enrollment","description":"OAuth 2.0 scope:okta.myAccount.appAuthenticator.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppAuthenticatorEnrollment","name":"Create an App Authenticator Enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1app-authenticators/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an App Authenticator Enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.appAuthenticator.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an app authenticator enrollment"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.myAccount.appAuthenticator.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope always enforces the Okta account management policy, regardless of whether end users have selected Keep me signed in (KMSI). This means that your Okta account management policy always applies to app authenticators that are created with this scope."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json, okta-version=1.0.0"],"mediaTypeSchemas":{"application/json, okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment"]}},"schemaId":"components/schemas/AppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment"],"pointer":"/paths/~1idp~1myaccount~1app-authenticators/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/app-authenticators","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json, okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment"]}},"responseCodes":["200","400","401","403","404","406"],"pointer":"/idp/myaccount/app-authenticators","href":"appauthenticator/createappauthenticatorenrollment","openApiOperationId":"createAppAuthenticatorEnrollment","summary":"Create an App Authenticator Enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/AppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment"],"mediaTypes":["application/json, okta-version=1.0.0"],"mediaTypeSchemas":{"application/json, okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollment"}},"schemaId":"components/schemas/AppAuthenticatorEnrollment"},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Access Denied","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Resource Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"406","description":"Not Acceptable","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error406"}},"schemaId":"components/schemas/Error406"}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppAuthenticatorEnrollment","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollment"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"406","schemaId":"components/schemas/Error406","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error406"}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/app-authenticators"},{"label":"Verify a Push Notification Challenge Response from the App Authenticator","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/verifyappauthenticatorpushnotificationchallenge","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/verifyappauthenticatorpushnotificationchallenge","metadata":{"seo":{"title":"Verify a Push Notification Challenge Response from the App Authenticator","description":"Identity Engine"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyAppAuthenticatorPushNotificationChallenge","name":"Verify a Push Notification Challenge Response from the App Authenticator","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a Push Notification Challenge Response from the App Authenticator","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies a push notification challenge from the app authenticator"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"challengeId","in":"path","schemaId":"schema_1488","description":"Id of the challenge associated with the app authenticator","required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeSchemas":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PushNotificationVerification","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload"]}},"schemaId":"components/schemas/PushNotificationVerification","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload"],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"challengeId","in":"path","required":true,"example":"ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW","schemaId":"schema_1488"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PushNotificationVerification","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload"]}},"responseCodes":["200","204","400","406"],"pointer":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify","href":"appauthenticator/verifyappauthenticatorpushnotificationchallenge","openApiOperationId":"verifyAppAuthenticatorPushNotificationChallenge","summary":"Verify a Push Notification Challenge Response from the App Authenticator"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/PushNotificationVerification","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeSchemas":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PushNotificationVerification","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification Success"},{"code":"204","description":"User denied challenge attempt"},{"code":"400","description":"Bad Request"},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"204"},{"code":"400"},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify"},{"label":"Update an App Authenticator Enrollment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/updateappauthenticatorenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/updateappauthenticatorenrollment","metadata":{"seo":{"title":"Update an App Authenticator Enrollment","description":"OAuth 2.0 scope:okta.myAccount.appAuthenticator.maintenance.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppAuthenticatorEnrollment","name":"Update an App Authenticator Enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an App Authenticator Enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.appAuthenticator.maintenance.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an app authenticator enrollment"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following update operations are allowed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the user verification key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove the user verification key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the push token"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the push method transaction types"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/#access-token-management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Custom authenticator integration guide."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The following higher risk update operations require a stronger "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.myAccount.appAuthenticator.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the user verification key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove the user verification key"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enrollmentId","in":"path","schemaId":"schema_1489","description":"Id of the user's app authenticator enrollment","required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/merge-patch+json;okta-version=1.0.0"],"mediaTypeSchemas":{"application/merge-patch+json;okta-version=1.0.0":{"schemaId":"components/schemas/UpdateAppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key"]}},"schemaId":"components/schemas/UpdateAppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key"],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/idp/myaccount/app-authenticators/{enrollmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"enrollmentId","in":"path","required":true,"example":"pfd7rzcmvlhmE0Y1w0g4","schemaId":"schema_1489"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json;okta-version=1.0.0":{"schemaId":"components/schemas/UpdateAppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key"]}},"responseCodes":["200","401","403","404","406"],"pointer":"/idp/myaccount/app-authenticators/{enrollmentId}","href":"appauthenticator/updateappauthenticatorenrollment","openApiOperationId":"updateAppAuthenticatorEnrollment","summary":"Update an App Authenticator Enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/UpdateAppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key"],"mediaTypes":["application/merge-patch+json;okta-version=1.0.0"],"mediaTypeSchemas":{"application/merge-patch+json;okta-version=1.0.0":{"schemaId":"components/schemas/UpdateAppAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollment"}},"schemaId":"components/schemas/AppAuthenticatorEnrollment"},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Access Denied","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Resource Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"406","description":"Not Acceptable","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error406"}},"schemaId":"components/schemas/Error406"}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppAuthenticatorEnrollment","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/AppAuthenticatorEnrollment"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"406","schemaId":"components/schemas/Error406","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error406"}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/app-authenticators/{enrollmentId}"},{"label":"Delete an App Authenticator Enrollment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/deleteappauthenticatorenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/deleteappauthenticatorenrollment","metadata":{"seo":{"title":"Delete an App Authenticator Enrollment","description":"OAuth 2.0 scope:okta.myAccount.appAuthenticator.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppAuthenticatorEnrollment","name":"Delete an App Authenticator Enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an App Authenticator Enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.appAuthenticator.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an app authenticator enrollment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enrollmentId","in":"path","schemaId":"schema_1489","description":"Id of the user's app authenticator enrollment","required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idp/myaccount/app-authenticators/{enrollmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"enrollmentId","in":"path","required":true,"example":"pfd7rzcmvlhmE0Y1w0g4","schemaId":"schema_1489"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["204","401","403","404","406"],"pointer":"/idp/myaccount/app-authenticators/{enrollmentId}","href":"appauthenticator/deleteappauthenticatorenrollment","openApiOperationId":"deleteAppAuthenticatorEnrollment","summary":"Delete an App Authenticator Enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Access Denied","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Resource Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"406","description":"Not Acceptable","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error406"}},"schemaId":"components/schemas/Error406"}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"406","schemaId":"components/schemas/Error406","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error406"}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/app-authenticators/{enrollmentId}"},{"label":"List all pending Push Notification Challenges","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/appauthenticator/listappauthenticatorpendingpushnotificationchallenges","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/listappauthenticatorpendingpushnotificationchallenges","metadata":{"seo":{"title":"List all pending Push Notification Challenges","description":"OAuth 2.0 scope:okta.myAccount.appAuthenticator.maintenance.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAppAuthenticatorPendingPushNotificationChallenges","name":"List all pending Push Notification Challenges","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all pending Push Notification Challenges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.appAuthenticator.maintenance.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all pending push notification challenges"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enrollmentId","in":"path","schemaId":"schema_1489","description":"Id of the user's app authenticator enrollment","required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/app-authenticators/{enrollmentId}/push/notifications","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"enrollmentId","in":"path","required":true,"example":"pfd7rzcmvlhmE0Y1w0g4","schemaId":"schema_1489"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/app-authenticators/{enrollmentId}/push/notifications","href":"appauthenticator/listappauthenticatorpendingpushnotificationchallenges","openApiOperationId":"listAppAuthenticatorPendingPushNotificationChallenges","summary":"List all pending Push Notification Challenges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1490","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success response","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Payload"]}},"schemaId":"schema_1490","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success response","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Payload"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1490","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success response","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Payload"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1490","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success response","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Header","paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Payload"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/app-authenticators/{enrollmentId}/push/notifications"},{"type":"link","label":"PushNotificationChallengeRequestJwt","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwt","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwt","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PushNotificationChallengeRequestJwt"},"seo":{"title":"PushNotificationChallengeRequestJwt"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PushNotificationChallengeRequestJwt","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PushNotificationChallengeRequestJwt"},"children":[]}]}]}},{"type":"link","label":"PushNotificationChallengeRequestJwtHeader","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwtheader","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwtheader","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PushNotificationChallengeRequestJwtHeader"},"seo":{"title":"PushNotificationChallengeRequestJwtHeader"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PushNotificationChallengeRequestJwtHeader","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PushNotificationChallengeRequestJwtHeader"},"children":[]}]}]}},{"type":"link","label":"PushNotificationChallengeResponseJwt","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwt","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwt","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PushNotificationChallengeResponseJwt"},"seo":{"title":"PushNotificationChallengeResponseJwt"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PushNotificationChallengeResponseJwt","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PushNotificationChallengeResponseJwt"},"children":[]}]}]}},{"type":"link","label":"PushNotificationChallengeResponseJwtHeader","link":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwtheader","routeSlug":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwtheader","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"PushNotificationChallengeResponseJwtHeader"},"seo":{"title":"PushNotificationChallengeResponseJwtHeader"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"PushNotificationChallengeResponseJwtHeader","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/PushNotificationChallengeResponseJwtHeader"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"AppAuthenticator"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App Authenticators","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/authenticators-custom-authenticator/android/main/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom authenticator integration guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"PushNotificationChallengeRequestJwt","link":"/appauthenticator/pushnotificationchallengerequestjwt","deprecated":false},{"title":"PushNotificationChallengeRequestJwtHeader","link":"/appauthenticator/pushnotificationchallengerequestjwtheader","deprecated":false},{"title":"PushNotificationChallengeResponseJwt","link":"/appauthenticator/pushnotificationchallengeresponsejwt","deprecated":false},{"title":"PushNotificationChallengeResponseJwtHeader","link":"/appauthenticator/pushnotificationchallengeresponsejwtheader","deprecated":false}]},{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/app-authenticators","summary":"Create an App Authenticator Enrollment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appauthenticator/createappauthenticatorenrollment","deprecated":false},{"title":"/idp/myaccount/app-authenticators/challenge/{challengeId}/verify","summary":"Verify a Push Notification Challenge Response from the App Authenticator","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appauthenticator/verifyappauthenticatorpushnotificationchallenge","deprecated":false},{"title":"/idp/myaccount/app-authenticators/{enrollmentId}","summary":"Update an App Authenticator Enrollment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/appauthenticator/updateappauthenticatorenrollment","deprecated":false},{"title":"/idp/myaccount/app-authenticators/{enrollmentId}","summary":"Delete an App Authenticator Enrollment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appauthenticator/deleteappauthenticatorenrollment","deprecated":false},{"title":"/idp/myaccount/app-authenticators/{enrollmentId}/push/notifications","summary":"List all pending Push Notification Challenges","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appauthenticator/listappauthenticatorpendingpushnotificationchallenges","deprecated":false}]}]}]}]}},{"type":"group","label":"Authenticators","link":"/openapi/okta-myaccount/myaccount/authenticators","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/authenticators/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"authenticators/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"List all Authenticators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/listauthenticators","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/listauthenticators","metadata":{"seo":{"title":"List all Authenticators","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.authenticators.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAuthenticators","name":"List all Authenticators","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1authenticators/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Authenticators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.authenticators.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all of the authenticators for the current user"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"ea"}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When the Flexible Okta Verify authenticator configuration feature is enabled, the response includes both the individual per-method authenticators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta_verify_totp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta_verify_push"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta_verify_fastpass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and a legacy "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta_verify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" aggregate object for backward compatibility."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible Okta Verify authenticator configuration is a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/concepts/feature-lifecycle-management/#self-service-features"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"self-service Early Access (EA)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?id=ext_secur_manage_ea_bata"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Early Access and Beta features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the feature."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_1491","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes associated authenticator details in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute"},"children":[]}]}]}],"examples":{"AuthenticatorEnrollmentDetails":{"summary":"Expand to include authenticator enrollment details","value":"enrollments"},"AuthenticatorPasswordRequirements":{"summary":"Expand to include password requirements","value":"requirements"}}}],"pointer":"/paths/~1idp~1myaccount~1authenticators/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/authenticators","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"expand","in":"query","example":"enrollments","schemaId":"schema_1491"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","403","406","429"],"pointer":"/idp/myaccount/authenticators","href":"authenticators/listauthenticators","openApiOperationId":"listAuthenticators","summary":"List all Authenticators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authenticators","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1492","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators including all Okta Verify method-specific authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments including Okta Verify method-specific authenticators"]}},"schemaId":"schema_1492","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators including all Okta Verify method-specific authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments including Okta Verify method-specific authenticators"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1idp~1myaccount~1authenticators/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1492","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators including all Okta Verify method-specific authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments including Okta Verify method-specific authenticators"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1492","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators including all Okta Verify method-specific authenticators","paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments including Okta Verify method-specific authenticators"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/authenticators"},{"label":"Retrieve an Authenticator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/getauthenticator","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/getauthenticator","metadata":{"seo":{"title":"Retrieve an Authenticator","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.authenticators.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuthenticator","name":"Retrieve an Authenticator","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Authenticator","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.authenticators.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an authenticator by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authenticatorId"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticatorId","in":"path","schemaId":"schema_1493","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authenticator"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_1491","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes associated authenticator details in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute"},"children":[]}]}]}],"examples":{"AuthenticatorEnrollmentDetails":{"summary":"Expand to include authenticator enrollment details","value":"enrollments"},"AuthenticatorPasswordRequirements":{"summary":"Expand to include password requirements","value":"requirements"}}}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/authenticators/{authenticatorId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"authenticatorId","in":"path","required":true,"example":"aut9gnvcjUHIWb37J0g4","schemaId":"schema_1493"}],"query":[{"name":"expand","in":"query","example":"enrollments","schemaId":"schema_1491"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","403","404","406","429"],"pointer":"/idp/myaccount/authenticators/{authenticatorId}","href":"authenticators/getauthenticator","openApiOperationId":"getAuthenticator","summary":"Retrieve an Authenticator"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authenticator","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Authenticator","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Password authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Security key authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/External IdP authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify FastPass authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify Push authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify TOTP authenticator"]}},"schemaId":"components/schemas/Authenticator","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Password authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Security key authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/External IdP authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify FastPass authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify Push authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify TOTP authenticator"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Authenticator","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Password authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Security key authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/External IdP authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify FastPass authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify Push authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify TOTP authenticator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Authenticator","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Password authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Security key authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/External IdP authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify FastPass authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify Push authenticator","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify TOTP authenticator"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}"},{"label":"List all Enrollments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/listenrollments","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/listenrollments","metadata":{"seo":{"title":"List all Enrollments","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.authenticators.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnrollments","name":"List all Enrollments","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Enrollments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.authenticators.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all enrollments the current user has for an authenticator"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticatorId","in":"path","schemaId":"schema_1493","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authenticator"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/authenticators/{authenticatorId}/enrollments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"authenticatorId","in":"path","required":true,"example":"aut9gnvcjUHIWb37J0g4","schemaId":"schema_1493"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","403","404","406","429"],"pointer":"/idp/myaccount/authenticators/{authenticatorId}/enrollments","href":"authenticators/listenrollments","openApiOperationId":"listEnrollments","summary":"List all Enrollments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrollments","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1494","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/200/content/application~1json/examples/All security key and biometric enrollments"]}},"schemaId":"schema_1494","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/200/content/application~1json/examples/All security key and biometric enrollments"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1494","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/200/content/application~1json/examples/All security key and biometric enrollments"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1494","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/200/content/application~1json/examples/All security key and biometric enrollments"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}/enrollments"},{"label":"Retrieve an Enrollment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/getenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/getenrollment","metadata":{"seo":{"title":"Retrieve an Enrollment","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.authenticators.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnrollment","name":"Retrieve an Enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.authenticators.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an enrollment by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enrollmentId"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticatorId","in":"path","schemaId":"schema_1493","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authenticator"},"children":[]}]}]}],"required":true},{"name":"enrollmentId","in":"path","schemaId":"schema_1495","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authenticator enrollment"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"authenticatorId","in":"path","required":true,"example":"aut9gnvcjUHIWb37J0g4","schemaId":"schema_1493"},{"name":"enrollmentId","in":"path","required":true,"example":"ufs2bysphxKODSZKWVCT","schemaId":"schema_1495"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","403","404","406","429"],"pointer":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}","href":"authenticators/getenrollment","openApiOperationId":"getEnrollment","summary":"Retrieve an Enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrollment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticatorEnrollment","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Password enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Email enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Security key enrollment"]}},"schemaId":"components/schemas/AuthenticatorEnrollment","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Password enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Email enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Security key enrollment"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticatorEnrollment","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Password enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Email enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Security key enrollment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AuthenticatorEnrollment","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Password enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Email enrollment","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Security key enrollment"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}"},{"label":"Update an enrollment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/authenticators/updateenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/authenticators/updateenrollment","metadata":{"seo":{"title":"Update an enrollment","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.authenticators.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEnrollment","name":"Update an enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.authenticators.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an authenticator enrollment by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enrollmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following update operations are allowed:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the enrollment nickname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove the enrollment nickname"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authenticatorId","in":"path","schemaId":"schema_1493","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authenticator"},"children":[]}]}]}],"required":true},{"name":"enrollmentId","in":"path","schemaId":"schema_1495","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authenticator enrollment"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/merge-patch+json;okta-version=1.0.0"],"mediaTypeSchemas":{"application/merge-patch+json;okta-version=1.0.0":{"schemaId":"components/schemas/UpdateAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname"]}},"schemaId":"components/schemas/UpdateAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname"],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"authenticatorId","in":"path","required":true,"example":"aut9gnvcjUHIWb37J0g4","schemaId":"schema_1493"},{"name":"enrollmentId","in":"path","required":true,"example":"ufs2bysphxKODSZKWVCT","schemaId":"schema_1495"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json;okta-version=1.0.0":{"schemaId":"components/schemas/UpdateAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname"]}},"responseCodes":["200","401","403","404","406"],"pointer":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}","href":"authenticators/updateenrollment","openApiOperationId":"updateEnrollment","summary":"Update an enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/UpdateAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname"],"mediaTypes":["application/merge-patch+json;okta-version=1.0.0"],"mediaTypeSchemas":{"application/merge-patch+json;okta-version=1.0.0":{"schemaId":"components/schemas/UpdateAuthenticatorEnrollmentRequest","exampleIds":["paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname","paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/AuthenticatorEnrollment"}},"schemaId":"components/schemas/AuthenticatorEnrollment"},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Access Denied","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Resource Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AuthenticatorEnrollment","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/AuthenticatorEnrollment"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"406","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}"}],"content":{"contentType":"group","meta":{"name":"Authenticators"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authenticators","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle-container","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"oie"}},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount Authenticators API provides operations to list all available authenticators and enrollments."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/authenticators","summary":"List all Authenticators","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authenticators/listauthenticators","deprecated":false},{"title":"/idp/myaccount/authenticators/{authenticatorId}","summary":"Retrieve an Authenticator","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authenticators/getauthenticator","deprecated":false},{"title":"/idp/myaccount/authenticators/{authenticatorId}/enrollments","summary":"List all Enrollments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authenticators/listenrollments","deprecated":false},{"title":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}","summary":"Retrieve an Enrollment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authenticators/getenrollment","deprecated":false},{"title":"/idp/myaccount/authenticators/{authenticatorId}/enrollments/{enrollmentId}","summary":"Update an enrollment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/authenticators/updateenrollment","deprecated":false}]}]}]}]}},{"type":"group","label":"Email","link":"/openapi/okta-myaccount/myaccount/email","routeSlug":"/openapi/okta-myaccount/myaccount/email","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/email/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/email/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"email/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"List all Emails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/listemails","routeSlug":"/openapi/okta-myaccount/myaccount/email/listemails","metadata":{"seo":{"title":"List all Emails","description":"OAuth 2.0 scope:okta.myAccount.email.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEmails","name":"List all Emails","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Emails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all of the current user's email information: a collection of links for each email that describe the acceptable operations"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/emails","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/emails","href":"email/listemails","openApiOperationId":"listEmails","summary":"List all Emails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1496","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"schema_1496","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1emails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1496","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1496","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails"},{"label":"Create an Email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/createemail","routeSlug":"/openapi/okta-myaccount/myaccount/email/createemail","metadata":{"seo":{"title":"Create an Email","description":"OAuth 2.0 scope:okta.myAccount.email.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEmail","name":"Create an Email","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a primary or secondary email address for the user's account. The new email address has an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNVERIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1497","exampleIds":["paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email"]}},"schemaId":"schema_1497","exampleIds":["paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email"],"pointer":"/paths/~1idp~1myaccount~1emails/post/requestBody","description":"New email"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/emails","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1497","exampleIds":["paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email"]}},"responseCodes":["201","400","401","403","406","409"],"pointer":"/idp/myaccount/emails","href":"email/createemail","openApiOperationId":"createEmail","summary":"Create an Email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1497","exampleIds":["paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1497","exampleIds":["paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-400"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-400"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"409","description":"Conflict","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Email-Conflict-409"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Email-Conflict-409"]}],"pointer":"/paths/~1idp~1myaccount~1emails/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-400"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-400"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Email-Conflict-409"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Email-Conflict-409"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails"},{"label":"Retrieve an Email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/getemail","routeSlug":"/openapi/okta-myaccount/myaccount/email/getemail","metadata":{"seo":{"title":"Retrieve an Email","description":"OAuth 2.0 scope:okta.myAccount.email.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmail","name":"Retrieve an Email","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an Email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current user's email information by ID: a collection of links that describe the acceptable email operations"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1498","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations to obtain the email ID when adding a new email address."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/emails/{id}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"69dca29c2d8dbb0dca14395ccdb92317","schemaId":"schema_1498"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/emails/{id}","href":"email/getemail","openApiOperationId":"getEmail","summary":"Retrieve an Email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Email","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails/{id}"},{"label":"Delete an Email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/deleteemail","routeSlug":"/openapi/okta-myaccount/myaccount/email/deleteemail","metadata":{"seo":{"title":"Delete an Email","description":"OAuth 2.0 scope:okta.myAccount.email.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmail","name":"Delete an Email","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the current user's email information by ID. You can only delete unverified primary and secondary emails."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1498","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations to obtain the email ID when adding a new email address."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idp/myaccount/emails/{id}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"69dca29c2d8dbb0dca14395ccdb92317","schemaId":"schema_1498"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["204","400","401","404","406"],"pointer":"/idp/myaccount/emails/{id}","href":"email/deleteemail","openApiOperationId":"deleteEmail","summary":"Delete an Email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Deletion-400"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Deletion-400"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Deletion-400"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Deletion-400"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails/{id}"},{"label":"Send an Email Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/sendemailchallenge","routeSlug":"/openapi/okta-myaccount/myaccount/email/sendemailchallenge","metadata":{"seo":{"title":"Send an Email Challenge","description":"OAuth 2.0 scope:okta.myAccount.email.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendEmailChallenge","name":"Send an Email Challenge","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an Email Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a \"Confirm email address change\" email to the user with a one-time passcode for verification."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also, the user receives a \"Notice of pending email address change\" email. After the challenge is verified, the email becomes active."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1499","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations when adding a new email address."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1500","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example"]}},"schemaId":"schema_1500","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example"],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/emails/{id}/challenge","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"00T196qTp3LIMZQ0L0g3","schemaId":"schema_1499"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1500","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example"]}},"responseCodes":["201","401","403","404","406"],"pointer":"/idp/myaccount/emails/{id}/challenge","href":"email/sendemailchallenge","openApiOperationId":"sendEmailChallenge","summary":"Send an Email Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1500","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1500","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1501","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Challenge-Created-Response"]}},"schemaId":"schema_1501","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Challenge-Created-Response"],"headers":{}},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_1501","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Challenge-Created-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1501","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Challenge-Created-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails/{id}/challenge"},{"label":"Poll the Challenge for Email Magic Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/pollchallengeforemailmagiclink","routeSlug":"/openapi/okta-myaccount/myaccount/email/pollchallengeforemailmagiclink","metadata":{"seo":{"title":"Poll the Challenge for Email Magic Link","description":"OAuth 2.0 scope:okta.myAccount.email.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pollChallengeForEmailMagicLink","name":"Poll the Challenge for Email Magic Link","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Poll the Challenge for Email Magic Link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Polls for the email challenge's status"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1499","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations to obtain the ID when adding a new email address."},"children":[]}]}]}],"required":true},{"name":"challengeId","in":"path","schemaId":"schema_1502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the email"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails/{id}/challenge/"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to obtain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a new challenge."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/emails/{id}/challenge/{challengeId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"00T196qTp3LIMZQ0L0g3","schemaId":"schema_1499"},{"name":"challengeId","in":"path","required":true,"example":"x1MDGzUb","schemaId":"schema_1502"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","404","406"],"pointer":"/idp/myaccount/emails/{id}/challenge/{challengeId}","href":"email/pollchallengeforemailmagiclink","openApiOperationId":"pollChallengeForEmailMagicLink","summary":"Poll the Challenge for Email Magic Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1503","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Polling-Response-Example"]}},"schemaId":"schema_1503","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Polling-Response-Example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1503","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Polling-Response-Example"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1503","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Polling-Response-Example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails/{id}/challenge/{challengeId}"},{"label":"Verify an Email OTP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/email/verifyemailotp","routeSlug":"/openapi/okta-myaccount/myaccount/email/verifyemailotp","metadata":{"seo":{"title":"Verify an Email OTP","description":"OAuth 2.0 scope:okta.myAccount.email.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyEmailOtp","name":"Verify an Email OTP","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify an Email OTP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.email.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies the email challenge with the code that the user receives from the \"Confirm email address change\" email. Once verified, the email is active."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1499","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email ID"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operations to obtain the email ID when adding a new email address."},"children":[]}]}]}],"required":true},{"name":"challengeId","in":"path","schemaId":"schema_1502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the email"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/emails/{id}/challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation to obtain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when creating a new challenge."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1504","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example"]}},"schemaId":"schema_1504","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example"],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/emails/{id}/challenge/{challengeId}/verify","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"00T196qTp3LIMZQ0L0g3","schemaId":"schema_1499"},{"name":"challengeId","in":"path","required":true,"example":"x1MDGzUb","schemaId":"schema_1502"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1504","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example"]}},"responseCodes":["200","401","403","404","406"],"pointer":"/idp/myaccount/emails/{id}/challenge/{challengeId}/verify","href":"email/verifyemailotp","openApiOperationId":"verifyEmailOtp","summary":"Verify an Email OTP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1504","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1504","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/emails/{id}/challenge/{challengeId}/verify"}],"content":{"contentType":"group","meta":{"name":"Email"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount Email API provides operations to enroll, update, and delete emails. The API also provides utilities to create, view, and answer verification challenges."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The Okta account management policy doesn't support the MyAccount Email API. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/okta-account-management-policy/main/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure an Okta account management policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/emails","summary":"List all Emails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email/listemails","deprecated":false},{"title":"/idp/myaccount/emails","summary":"Create an Email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email/createemail","deprecated":false},{"title":"/idp/myaccount/emails/{id}","summary":"Retrieve an Email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email/getemail","deprecated":false},{"title":"/idp/myaccount/emails/{id}","summary":"Delete an Email","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/email/deleteemail","deprecated":false},{"title":"/idp/myaccount/emails/{id}/challenge","summary":"Send an Email Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email/sendemailchallenge","deprecated":false},{"title":"/idp/myaccount/emails/{id}/challenge/{challengeId}","summary":"Poll the Challenge for Email Magic Link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email/pollchallengeforemailmagiclink","deprecated":false},{"title":"/idp/myaccount/emails/{id}/challenge/{challengeId}/verify","summary":"Verify an Email OTP","prefix":{"name":"post","color":"post"},"badges":[],"link":"/email/verifyemailotp","deprecated":false}]}]}]}]}},{"type":"group","label":"Okta Applications","link":"/openapi/okta-myaccount/myaccount/oktaapplications","routeSlug":"/openapi/okta-myaccount/myaccount/oktaapplications","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/oktaapplications/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/oktaapplications/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"oktaapplications/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"List all Okta Apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/oktaapplications/listoktaapplications","routeSlug":"/openapi/okta-myaccount/myaccount/oktaapplications/listoktaapplications","metadata":{"seo":{"title":"List all Okta Apps","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.oktaApplications.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOktaApplications","name":"List all Okta Apps","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1okta-applications/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Okta Apps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.oktaApplications.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all of the current user's Okta apps"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1okta-applications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/okta-applications","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","400","406"],"pointer":"/idp/myaccount/okta-applications","href":"oktaapplications/listoktaapplications","openApiOperationId":"listOktaApplications","summary":"List all Okta Apps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1505","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"schema_1505","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/400/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/400/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1okta-applications/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1505","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1505","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/400/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/400/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1okta-applications/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/okta-applications"}],"content":{"contentType":"group","meta":{"name":"OktaApplications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Okta Applications","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle-container","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"oie"}},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/okta-applications","summary":"List all Okta Apps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/oktaapplications/listoktaapplications","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization","link":"/openapi/okta-myaccount/myaccount/organization","routeSlug":"/openapi/okta-myaccount/myaccount/organization","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/organization/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/organization/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"organization/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"Retrieve the Org Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/organization/getorganization","routeSlug":"/openapi/okta-myaccount/myaccount/organization/getorganization","metadata":{"seo":{"title":"Retrieve the Org Details","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.organization.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganization","name":"Retrieve the Org Details","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1organization/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the Org Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.organization.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the org details"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1organization/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/organization","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/organization","href":"organization/getorganization","openApiOperationId":"getOrganization","summary":"Retrieve the Org Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Organization","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Organization","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1organization/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organization","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Organization","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1organization/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/organization"}],"content":{"contentType":"group","meta":{"name":"Organization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle-container","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"oie"}},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount Profile API provides operations to view org details."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/organization","summary":"Retrieve the Org Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization/getorganization","deprecated":false}]}]}]}]}},{"type":"group","label":"Password","link":"/openapi/okta-myaccount/myaccount/password","routeSlug":"/openapi/okta-myaccount/myaccount/password","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/password/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/password/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"password/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"Retrieve a Password","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/getpassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/getpassword","metadata":{"seo":{"title":"Retrieve a Password","description":"OAuth 2.0 scope:okta.myAccount.password.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPassword","name":"Retrieve a Password","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1password/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.password.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current user's password status"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This request only returns information about the password, not the password itself."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1password/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/password","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/password","href":"password/getpassword","openApiOperationId":"getPassword","summary":"Retrieve a Password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1password/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/password"},{"label":"Create a Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/createpassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/createpassword","metadata":{"seo":{"title":"Create a Password","description":"OAuth 2.0 scope:okta.myAccount.password.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPassword","name":"Create a Password","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1password/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.password.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates and enrolls a password for the current user"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1password/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password"]}},"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password"],"pointer":"/paths/~1idp~1myaccount~1password/post/requestBody","description":"New password"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/password","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password"]}},"responseCodes":["201","400","401","403","406"],"pointer":"/idp/myaccount/password","href":"password/createpassword","openApiOperationId":"createPassword","summary":"Create a Password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Conflict","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Password-Conflict-409"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Password-Conflict-409"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1password/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Password-Conflict-409"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Password-Conflict-409"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/post/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/password"},{"label":"Replace a Password","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/replacepassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/replacepassword","metadata":{"seo":{"title":"Replace a Password","description":"OAuth 2.0 scope:okta.myAccount.password.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replacePassword","name":"Replace a Password","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1password/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a Password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.password.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the password for the current user by resetting it. A password reset doesn't require the user to know the existing password."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Azure Active Directory (AD) users don't have permission to reset passwords by default. You need to configure this permission through your AD instance. If you don't have this permission as an AD user, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-myaccount/myaccount/tag/Password/#tag/Password/operation/updatePassword"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Password"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1password/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password"]}},"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password"],"pointer":"/paths/~1idp~1myaccount~1password/put/requestBody","description":"New password"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/idp/myaccount/password","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password"]}},"responseCodes":["201","400","401","403","406"],"pointer":"/idp/myaccount/password","href":"password/replacepassword","openApiOperationId":"replacePassword","summary":"Replace a Password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1506","exampleIds":["paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1password/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/put/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/password"},{"label":"Delete a Password","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/deletepassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/deletepassword","metadata":{"seo":{"title":"Delete a Password","description":"OAuth 2.0 scope:okta.myAccount.password.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePassword","name":"Delete a Password","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1password/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.password.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the current user's enrolled password"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1password/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idp/myaccount/password","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["204","401","404","406"],"pointer":"/idp/myaccount/password","href":"password/deletepassword","openApiOperationId":"deletePassword","summary":"Delete a Password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Password-Resource-Not-Found-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Password-Resource-Not-Found-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1password/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Password-Resource-Not-Found-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Password-Resource-Not-Found-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1password/delete/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/password"},{"label":"Update a Password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/updatepassword","routeSlug":"/openapi/okta-myaccount/myaccount/password/updatepassword","metadata":{"seo":{"title":"Update a Password","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.password.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePassword","name":"Update a Password","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1password~1change-password/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Password","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.password.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a password. The user needs to know the current password to change it."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1password~1change-password/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1507","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password"]}},"schemaId":"schema_1507","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password"],"pointer":"/paths/~1idp~1myaccount~1password~1change-password/post/requestBody","description":"New password"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/password/change-password","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1507","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password"]}},"responseCodes":["204","400","401","403"],"pointer":"/idp/myaccount/password/change-password","href":"password/updatepassword","openApiOperationId":"updatePassword","summary":"Update a Password"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1507","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1507","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/MFA-Assurance-Not-Satisfied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/MFA-Assurance-Not-Satisfied"]}],"pointer":"/paths/~1idp~1myaccount~1password~1change-password/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/MFA-Assurance-Not-Satisfied"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1change-password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/MFA-Assurance-Not-Satisfied"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/password/change-password"},{"label":"Retrieve the Password Complexity Requirements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/password/getpasswordrequirements","routeSlug":"/openapi/okta-myaccount/myaccount/password/getpasswordrequirements","metadata":{"seo":{"title":"Retrieve the Password Complexity Requirements","description":"Identity EngineOAuth 2.0 scope:okta.myAccount.password.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPasswordRequirements","name":"Retrieve the Password Complexity Requirements","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1password~1complexity-requirements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the Password Complexity Requirements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge oie","style":{"cursor":"pointer","background":"rgb(0, 41, 122)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Identity Engine"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.password.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the password complexity requirements for the current user"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1password~1complexity-requirements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/password/complexity-requirements","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401"],"pointer":"/idp/myaccount/password/complexity-requirements","href":"password/getpasswordrequirements","openApiOperationId":"getPasswordRequirements","summary":"Retrieve the Password Complexity Requirements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}],"pointer":"/paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/PasswordResponse","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/password/complexity-requirements"}],"content":{"contentType":"group","meta":{"name":"Password"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Password","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount Password API provides operations to enroll, update, and delete passwords."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The Okta account management policy doesn't support the MyAccount Password API. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/okta-account-management-policy/main/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure an Okta account management policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/password","summary":"Retrieve a Password","prefix":{"name":"get","color":"get"},"badges":[],"link":"/password/getpassword","deprecated":false},{"title":"/idp/myaccount/password","summary":"Create a Password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/password/createpassword","deprecated":false},{"title":"/idp/myaccount/password","summary":"Replace a Password","prefix":{"name":"put","color":"put"},"badges":[],"link":"/password/replacepassword","deprecated":false},{"title":"/idp/myaccount/password","summary":"Delete a Password","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/password/deletepassword","deprecated":false},{"title":"/idp/myaccount/password/change-password","summary":"Update a Password","prefix":{"name":"post","color":"post"},"badges":[],"link":"/password/updatepassword","deprecated":false},{"title":"/idp/myaccount/password/complexity-requirements","summary":"Retrieve the Password Complexity Requirements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/password/getpasswordrequirements","deprecated":false}]}]}]}]}},{"type":"group","label":"Phone","link":"/openapi/okta-myaccount/myaccount/phone","routeSlug":"/openapi/okta-myaccount/myaccount/phone","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/phone/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/phone/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"phone/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"List all Phones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/listphones","routeSlug":"/openapi/okta-myaccount/myaccount/phone/listphones","metadata":{"seo":{"title":"List all Phones","description":"OAuth 2.0 scope:okta.myAccount.phone.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPhones","name":"List all Phones","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1phones/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Phones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.phone.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the current user's phone information for all phones. Includes a collection of links for each phone describing the acceptable operations."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/phones","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/phones","href":"phone/listphones","openApiOperationId":"listPhones","summary":"List all Phones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1508","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"schema_1508","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1phones/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1508","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1508","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/phones"},{"label":"Create a Phone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/createphone","routeSlug":"/openapi/okta-myaccount/myaccount/phone/createphone","metadata":{"seo":{"title":"Create a Phone","description":"OAuth 2.0 scope:okta.myAccount.phone.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPhone","name":"Create a Phone","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1phones/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Phone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.phone.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNVERIFIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status phone for either the SMS or CALL method to the user's MyAccount setting"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1509","exampleIds":["paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge"]}},"schemaId":"schema_1509","exampleIds":["paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge"],"pointer":"/paths/~1idp~1myaccount~1phones/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/phones","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1509","exampleIds":["paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge"]}},"responseCodes":["201","400","401","403","406","409","500"],"pointer":"/idp/myaccount/phones","href":"phone/createphone","openApiOperationId":"createPhone","summary":"Create a Phone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1509","exampleIds":["paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1509","exampleIds":["paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Not-A-Number","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Country-Code","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Too-Long","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Not-A-Number","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Country-Code","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Too-Long","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"409","description":"Conflict","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Phone-Number-Exists-409"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Phone-Number-Exists-409"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"]}],"pointer":"/paths/~1idp~1myaccount~1phones/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Not-A-Number","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Country-Code","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Too-Long","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Not-A-Number","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Country-Code","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Too-Long","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Phone-Number-Exists-409"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Phone-Number-Exists-409"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/phones"},{"label":"Retrieve a Phone","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/getphone","routeSlug":"/openapi/okta-myaccount/myaccount/phone/getphone","metadata":{"seo":{"title":"Retrieve a Phone","description":"OAuth 2.0 scope:okta.myAccount.phone.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPhone","name":"Retrieve a Phone","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a Phone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.phone.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current user's phone information by ID. Along with a collection of links describing the operations that can be performed to the phone."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1510","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the phone. Obtain the ID of the phone through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when adding a new phone."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/phones/{id}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sms10ltpSdwXJCem80g4","schemaId":"schema_1510"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","404","406"],"pointer":"/idp/myaccount/phones/{id}","href":"phone/getphone","openApiOperationId":"getPhone","summary":"Retrieve a Phone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Phone","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/phones/{id}"},{"label":"Delete a Phone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/deletephone","routeSlug":"/openapi/okta-myaccount/myaccount/phone/deletephone","metadata":{"seo":{"title":"Delete a Phone","description":"OAuth 2.0 scope:okta.myAccount.phone.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePhone","name":"Delete a Phone","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Phone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.phone.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the current user's phone information by ID"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1510","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the phone. Obtain the ID of the phone through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when adding a new phone."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idp/myaccount/phones/{id}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sms10ltpSdwXJCem80g4","schemaId":"schema_1510"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["204","401","403","404","406"],"pointer":"/idp/myaccount/phones/{id}","href":"phone/deletephone","openApiOperationId":"deletePhone","summary":"Delete a Phone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/phones/{id}"},{"label":"Send a Phone Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/sendphonechallenge","routeSlug":"/openapi/okta-myaccount/myaccount/phone/sendphonechallenge","metadata":{"seo":{"title":"Send a Phone Challenge","description":"OAuth 2.0 scope:okta.myAccount.phone.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendPhoneChallenge","name":"Send a Phone Challenge","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1challenge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a Phone Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.phone.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends a phone challenge using one of two methods: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This request can also handle a resend challenge (retry)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upon a successful challenge, the user receives a verification code by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/idp/myaccount/phones/{id}/verify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to use the verification code to verify the phone number. The verification code expires in five minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending requests to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/idp/myaccount/phones/{id}/challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint more often than once every 30 seconds, or at a rate that exceeds the rate limit rule configured by the admin, returns a 429 (Too Many Requests) error."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1511","required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1512","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge"]}},"schemaId":"schema_1512","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge"],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/phones/{id}/challenge","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sms18vtfKgzqDhNqP0g4","schemaId":"schema_1511"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1512","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge"]}},"responseCodes":["200","400","401","403","404","406","500"],"pointer":"/idp/myaccount/phones/{id}/challenge","href":"phone/sendphonechallenge","openApiOperationId":"sendPhoneChallenge","summary":"Send a Phone Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1512","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1512","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response after challenging a phone","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1513","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"schema_1513","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"]}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1513","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"schema_1513","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/phones/{id}/challenge"},{"label":"Verify a Phone Challenge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/phone/verifyphonechallenge","routeSlug":"/openapi/okta-myaccount/myaccount/phone/verifyphonechallenge","metadata":{"seo":{"title":"Verify a Phone Challenge","description":"OAuth 2.0 scope:okta.myAccount.phone.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyPhoneChallenge","name":"Verify a Phone Challenge","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1verify/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a Phone Challenge","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.phone.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifies the phone number with the verification code that the user receives through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SMS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The phone number is active upon a successful verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sending requests to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/idp/myaccount/phones/{id}/verify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint at a rate that exceeds the rate limit rule configured by the admin returns a 429 (Too Many Requests) error."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1514","required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1verify/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1verify/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1515","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge"]}},"schemaId":"schema_1515","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge"],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/phones/{id}/verify","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"sms18vtfKgzqDhNqP0g4","schemaId":"schema_1514"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1515","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge"]}},"responseCodes":["204","400","401","403","404","406","409"],"pointer":"/idp/myaccount/phones/{id}/verify","href":"phone/verifyphonechallenge","openApiOperationId":"verifyPhoneChallenge","summary":"Verify a Phone Challenge"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1515","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1515","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]},{"code":"404","description":"Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]},{"code":"409","description":"Conflict","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-409"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-409"]}],"pointer":"/paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled","paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-409"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-409"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/phones/{id}/verify"}],"content":{"contentType":"group","meta":{"name":"Phone"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phone","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The Okta account management policy doesn't support the MyAccount Phone API. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/okta-account-management-policy/main/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure an Okta account management policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/phones","summary":"List all Phones","prefix":{"name":"get","color":"get"},"badges":[],"link":"/phone/listphones","deprecated":false},{"title":"/idp/myaccount/phones","summary":"Create a Phone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phone/createphone","deprecated":false},{"title":"/idp/myaccount/phones/{id}","summary":"Retrieve a Phone","prefix":{"name":"get","color":"get"},"badges":[],"link":"/phone/getphone","deprecated":false},{"title":"/idp/myaccount/phones/{id}","summary":"Delete a Phone","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/phone/deletephone","deprecated":false},{"title":"/idp/myaccount/phones/{id}/challenge","summary":"Send a Phone Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phone/sendphonechallenge","deprecated":false},{"title":"/idp/myaccount/phones/{id}/verify","summary":"Verify a Phone Challenge","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phone/verifyphonechallenge","deprecated":false}]}]}]}]}},{"type":"group","label":"Profile","link":"/openapi/okta-myaccount/myaccount/profile","routeSlug":"/openapi/okta-myaccount/myaccount/profile","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/profile/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/profile/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"profile/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"Retrieve my Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/profile/getprofile","routeSlug":"/openapi/okta-myaccount/myaccount/profile/getprofile","metadata":{"seo":{"title":"Retrieve my Profile","description":"OAuth 2.0 scope:okta.myAccount.profile.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProfile","name":"Retrieve my Profile","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1profile/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve my Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.profile.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the caller's Okta user profile, without attributes excluded by the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-myaccount/myaccount/profile/getprofileschema"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get my user profile schema"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1profile/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/profile","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/profile","href":"profile/getprofile","openApiOperationId":"getProfile","summary":"Retrieve my Profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Example response","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1profile/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/profile"},{"label":"Replace my User Profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/profile/replaceprofile","routeSlug":"/openapi/okta-myaccount/myaccount/profile/replaceprofile","metadata":{"seo":{"title":"Replace my User Profile","description":"OAuth 2.0 scope:okta.myAccount.profile.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceProfile","name":"Replace my User Profile","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1profile/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace my User Profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.profile.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the caller's user profile"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API differs from the the existing "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/reference/api/users/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Users API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in that only the PUT operation is supported.  Partial updates (PATCH requests) aren't available. All values returned by fetching a user profile must pass to the MyAccount API, or the update doesn't pass validation. This applies even if the omitted schema property is optional. To ensure an optional property passes, enter a value of 'null'."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta account management policy doesn't support PUT requests to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/idp/myaccount/profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/okta-account-management-policy/main/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure an Okta account management policy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1profile/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1516","exampleIds":["paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile"]}},"schemaId":"schema_1516","exampleIds":["paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile"],"pointer":"/paths/~1idp~1myaccount~1profile/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/idp/myaccount/profile","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1516","exampleIds":["paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile"]}},"responseCodes":["200","400","401","406"],"pointer":"/idp/myaccount/profile","href":"profile/replaceprofile","openApiOperationId":"replaceProfile","summary":"Replace my User Profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1516","exampleIds":["paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1516","exampleIds":["paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Update-From-Profile","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Value-Type-For-Property","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Missing-Property-Value-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Read-Only-Property-Changed-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Corrupt-Profile-Prevents-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Concealed-Or-Unknown-Property-For-Self-Update"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Update-From-Profile","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Value-Type-For-Property","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Missing-Property-Value-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Read-Only-Property-Changed-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Corrupt-Profile-Prevents-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Concealed-Or-Unknown-Property-For-Self-Update"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1profile/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Profile","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Update-From-Profile","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Value-Type-For-Property","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Missing-Property-Value-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Read-Only-Property-Changed-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Corrupt-Profile-Prevents-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Concealed-Or-Unknown-Property-For-Self-Update"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Update-From-Profile","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Value-Type-For-Property","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Missing-Property-Value-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Read-Only-Property-Changed-For-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Corrupt-Profile-Prevents-Self-Update","paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Concealed-Or-Unknown-Property-For-Self-Update"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile/put/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/profile"},{"label":"Retrieve my Profile Schema","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/profile/getprofileschema","routeSlug":"/openapi/okta-myaccount/myaccount/profile/getprofileschema","metadata":{"seo":{"title":"Retrieve my Profile Schema","description":"OAuth 2.0 scope:okta.myAccount.profile.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProfileSchema","name":"Retrieve my Profile Schema","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1profile~1schema/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve my Profile Schema","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.profile.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the appropriate user profile schema for the caller's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user type"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If a property's value isn't visible to an end user (because it's hidden or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?id=ext-hide-sensitive-attributes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sensitive"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), then the property's definition is also hidden in the output of the MyAccount API."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1profile~1schema/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/profile/schema","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/profile/schema","href":"profile/getprofileschema","openApiOperationId":"getProfileSchema","summary":"Retrieve my Profile Schema"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Schema","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}},"schemaId":"components/schemas/Schema","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1profile~1schema/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Schema","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Schema","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1profile~1schema/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/profile/schema"}],"content":{"contentType":"group","meta":{"name":"Profile"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Profile","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount Profile API provides operations to enroll and update profile fields. The API also allows viewing of all allowed profile fields."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/profile","summary":"Retrieve my Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/getprofile","deprecated":false},{"title":"/idp/myaccount/profile","summary":"Replace my User Profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/profile/replaceprofile","deprecated":false},{"title":"/idp/myaccount/profile/schema","summary":"Retrieve my Profile Schema","prefix":{"name":"get","color":"get"},"badges":[],"link":"/profile/getprofileschema","deprecated":false}]}]}]}]}},{"type":"group","label":"Sessions","link":"/openapi/okta-myaccount/myaccount/sessions","routeSlug":"/openapi/okta-myaccount/myaccount/sessions","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/sessions/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/sessions/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"sessions/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"Delete all Sessions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/sessions/deletesessions","routeSlug":"/openapi/okta-myaccount/myaccount/sessions/deletesessions","metadata":{"seo":{"title":"Delete all Sessions","description":"OAuth 2.0 scope:okta.myAccount.sessions.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSessions","name":"Delete all Sessions","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1sessions/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete all Sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.sessions.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes all sessions. Revokes all active identity provider sessions of the user. This forces the user to authenticate on the next operation. Also revokes OpenID Connect and OAuth refresh and access tokens issued to the user."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"oauthTokens","in":"query","schemaId":"schema_1517","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter.  Defaults to 'true', which deletes OAuth refresh tokens and access tokens.  Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to keep OAuth refresh tokens and access tokens active."},"children":[]}]}]}]},{"name":"excludeCurrentAuthorizationContext","in":"query","schemaId":"schema_1518","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional parameter.  If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", excludes the current authorization context from being revoked.  Defaults to false."},"children":[]}]}]}]}],"pointer":"/paths/~1idp~1myaccount~1sessions/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1sessions/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idp/myaccount/sessions","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"oauthTokens","in":"query","required":false,"schemaId":"schema_1517"},{"name":"excludeCurrentAuthorizationContext","in":"query","required":false,"schemaId":"schema_1518"}],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["204","401","404","406"],"pointer":"/idp/myaccount/sessions","href":"sessions/deletesessions","openApiOperationId":"deleteSessions","summary":"Delete all Sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Resource Not Found","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"406","description":"Not Acceptable","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1idp~1myaccount~1sessions/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}},{"code":"406","schemaId":"components/schemas/Error","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/sessions"}],"content":{"contentType":"group","meta":{"name":"Sessions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sessions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount Sessions API provides operations to manage sessions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-myaccount/myaccount/sessions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sessions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/sessions","summary":"Delete all Sessions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sessions/deletesessions","deprecated":false}]}]}]}]}},{"type":"group","label":"WebAuthn","link":"/openapi/okta-myaccount/myaccount/webauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn","items":[{"type":"link","label":"API versioning","link":"/openapi/okta-myaccount/myaccount/webauthn/api-versioning","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/api-versioning","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"API versioning"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webauthn/api-versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid API version in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is required to access the API. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Accept: application/json; okta-version=1.0.0\n"},"children":[]}]}]}],"panels":[]}]}},{"label":"List all WebAuthn enrollments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/listwebauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/listwebauthn","metadata":{"seo":{"title":"List all WebAuthn enrollments","description":"OAuth 2.0 scope:okta.myAccount.webauthn.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebAuthn","name":"List all WebAuthn enrollments","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1webauthn/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all WebAuthn enrollments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.webauthn.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all of the specified user's Passkey (FIDO2 WebAuthn) enrollments"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/webauthn","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","406"],"pointer":"/idp/myaccount/webauthn","href":"webauthn/listwebauthn","openApiOperationId":"listWebAuthn","summary":"List all WebAuthn enrollments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]}},"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1webauthn/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/webauthn"},{"label":"Create a WebAuthn enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/createwebauthnenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/createwebauthnenrollment","metadata":{"seo":{"title":"Create a WebAuthn enrollment","description":"OAuth 2.0 scope:okta.myAccount.webauthn.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebAuthnEnrollment","name":"Create a WebAuthn enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1webauthn/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a WebAuthn enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.webauthn.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a Passkey (FIDO2 WebAuthn) enrollment. Before using this endpoint, ensure that you've used the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-myaccount/myaccount/tag/WebAuthn/#tag/WebAuthn/operation/startWebAuthnEnrollment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a WebAuthn enrollment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint first."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebAuthnRequest","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment"]}},"schemaId":"components/schemas/CreateWebAuthnRequest","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment"],"pointer":"/paths/~1idp~1myaccount~1webauthn/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/webauthn","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebAuthnRequest","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment"]}},"responseCodes":["200","400","401","404","406"],"pointer":"/idp/myaccount/webauthn","href":"webauthn/createwebauthnenrollment","openApiOperationId":"createWebAuthnEnrollment","summary":"Create a WebAuthn enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/CreateWebAuthnRequest","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebAuthnRequest","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]}},"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1webauthn/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn/post/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/webauthn"},{"label":"Start a WebAuthn enrollment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/startwebauthnenrollment","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/startwebauthnenrollment","metadata":{"seo":{"title":"Start a WebAuthn enrollment","description":"OAuth 2.0 scope:okta.myAccount.webauthn.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startWebAuthnEnrollment","name":"Start a WebAuthn enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1webauthn~1registration/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a WebAuthn enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.webauthn.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the enrollment process for a Passkey (FIDO2 WebAuthn) authenticator. Complete the enrollment process by using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-myaccount/myaccount/tag/WebAuthn/#tag/WebAuthn/operation/createWebAuthnEnrollment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a WebAuthn enrollment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Don't supply a request body for this operation. To start the enrollment process, send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/idp/myaccount/webauthn/registration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. The response contains the challenge and options for the Passkey (FIDO2 WebAuthn) credential creation."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1registration/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{}},"pointer":"/paths/~1idp~1myaccount~1webauthn~1registration/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idp/myaccount/webauthn/registration","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"requestBody":{"application/json":{}},"responseCodes":["200","400","401","403","406"],"pointer":"/idp/myaccount/webauthn/registration","href":"webauthn/startwebauthnenrollment","openApiOperationId":"startWebAuthnEnrollment","summary":"Start a WebAuthn enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthnRegistrationOptions","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Start WebAuthn enrollment response"]}},"schemaId":"components/schemas/WebAuthnRegistrationOptions","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Start WebAuthn enrollment response"]},{"code":"400","description":"Bad Request","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"403","description":"Forbidden","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1registration/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAuthnRegistrationOptions","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Start WebAuthn enrollment response"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthnRegistrationOptions","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Start WebAuthn enrollment response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1registration/post/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/webauthn/registration"},{"label":"Retrieve a WebAuthn enrollment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/getwebauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/getwebauthn","metadata":{"seo":{"title":"Retrieve a WebAuthn enrollment","description":"OAuth 2.0 scope:okta.myAccount.webauthn.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebAuthn","name":"Retrieve a WebAuthn enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a WebAuthn enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.webauthn.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a Passkey (FIDO2 WebAuthn) enrollment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1519","description":"Unique identifier of the Passkey (FIDO2 WebAuthn) enrollment","required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idp/myaccount/webauthn/{id}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"fwfn3c3rryqStmyp20g4","schemaId":"schema_1519"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["200","401","404","406"],"pointer":"/idp/myaccount/webauthn/{id}","href":"webauthn/getwebauthn","openApiOperationId":"getWebAuthn","summary":"Retrieve a WebAuthn enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]}},"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/WebAuthn","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/webauthn/{id}"},{"label":"Delete a WebAuthn enrollment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/okta-myaccount/myaccount/webauthn/deletewebauthn","routeSlug":"/openapi/okta-myaccount/myaccount/webauthn/deletewebauthn","metadata":{"seo":{"title":"Delete a WebAuthn enrollment","description":"OAuth 2.0 scope:okta.myAccount.webauthn.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebAuthn","name":"Delete a WebAuthn enrollment","isWebhook":false,"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a WebAuthn enrollment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.myAccount.webauthn.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a specified Passkey (FIDO2 WebAuthn) enrollment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_1519","description":"Unique identifier of the Passkey (FIDO2 WebAuthn) enrollment","required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept","in":"header","schemaId":"schema_1487","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the API version. Current version: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1.0.0"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idp/myaccount/webauthn/{id}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"fwfn3c3rryqStmyp20g4","schemaId":"schema_1519"}],"query":[],"querystring":[],"header":[{"name":"Accept","in":"header","required":true,"example":"application/json; okta-version=1.0.0","schemaId":"schema_1487"}],"cookie":[]},"security":[],"responseCodes":["204","401","404","406"],"pointer":"/idp/myaccount/webauthn/{id}","href":"webauthn/deletewebauthn","openApiOperationId":"deleteWebAuthn","summary":"Delete a WebAuthn enrollment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","description":"Unauthorized","mediaType":"application/json;okta-version=1.0.0","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"406","description":"Not Acceptable (missing header)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}},"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}],"pointer":"/paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"],"mediaTypes":["application/json;okta-version=1.0.0"],"mediaTypeContent":{"application/json;okta-version=1.0.0":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"406","schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error406","exampleIds":["paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"]}}}],"examples":[]}]}]}]},"httpPath":"/idp/myaccount/webauthn/{id}"}],"content":{"contentType":"group","meta":{"name":"WebAuthn"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WebAuthn","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MyAccount WebAuthn API provides operations to enroll, list, and delete Passkey (FIDO2 WebAuthn) enrollments."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" As of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026.04.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" release, the FIDO2 (WebAuthn) authenticator is now called Passkey (FIDO2 WebAuthn) and there are new settings and updates to the authenticator page layout. There have been no changes to any existing parameter names, values, or endpoint paths. For example, the authenticator "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the Passkey (FIDO2 WebAuthn) authenticator is still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webauthn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/authenticators-web-authn/aspnet/main/#passkeys-and-webauthn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Passkeys and WebAuthn"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The registration for a Passkey (FIDO2 WebAuthn) authenticator (also known as the attestation ceremony) involves a challenge request and response. When you enroll a Passkey (FIDO2 WebAuthn) authenticator, use the following endpoints in this order:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-myaccount/myaccount/tag/WebAuthn/#tag/WebAuthn/operation/startWebAuthnEnrollment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a WebAuthn enrollment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This endpoint returns a random challenge and other data from the Relying Party (RP)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-myaccount/myaccount/tag/WebAuthn/#tag/WebAuthn/operation/createWebAuthnEnrollment"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a WebAuthn enrollment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This endpoint creates and sends a signed response that contains the challenge and other data from the RP."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idp/myaccount/webauthn","summary":"List all WebAuthn enrollments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webauthn/listwebauthn","deprecated":false},{"title":"/idp/myaccount/webauthn","summary":"Create a WebAuthn enrollment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webauthn/createwebauthnenrollment","deprecated":false},{"title":"/idp/myaccount/webauthn/registration","summary":"Start a WebAuthn enrollment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webauthn/startwebauthnenrollment","deprecated":false},{"title":"/idp/myaccount/webauthn/{id}","summary":"Retrieve a WebAuthn enrollment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webauthn/getwebauthn","deprecated":false},{"title":"/idp/myaccount/webauthn/{id}","summary":"Delete a WebAuthn enrollment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webauthn/deletewebauthn","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AppAuthenticatorEnrollment":{"id":"components/schemas/AppAuthenticatorEnrollment","kind":"json-schema","title":"AppAuthenticatorEnrollment","data":{"description":"App authenticator enrollment object","type":"object","properties":{"authenticatorId":{"type":"string","readOnly":true},"createdDate":{"type":"string","format":"date-time","readOnly":true},"device":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ACTIVE"]},"createdDate":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"clientInstanceId":{"type":"string"}},"readOnly":true},"id":{"type":"string","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","readOnly":true},"links":{"type":"object","description":"Discoverable resources related to the app authenticator","properties":{"self":{"type":"object","description":"Link to the resource (app authenticator)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["PATCH","DELETE"]}}}}}}},"readOnly":true},"methods":{"type":"object","properties":{"push":{"type":"object","properties":{"id":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"links":{"type":"object","properties":{"pending":{"type":"object","properties":{"href":{"type":"string","minLength":1},"hints":{"type":"object","properties":{"allow":{"type":"array","items":{"type":"string","enum":["GET"]}}}}}}}}}}}},"user":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"}},"readOnly":true}}}},"components/schemas/AppAuthenticatorEnrollmentRequest":{"id":"components/schemas/AppAuthenticatorEnrollmentRequest","kind":"json-schema","title":"AppAuthenticatorEnrollmentRequest","data":{"description":"App authenticator enrollment request","type":"object","properties":{"authenticatorId":{"type":"string"},"device":{"type":"object","properties":{"secureHardwarePresent":{"type":"boolean","description":"Indicates if the device is equipped with TPM storage for storing signing keys"},"clientInstanceKey":{"$ref":"#/components/schemas/KeyObject","description":"A public key in Json Web Keys format that is not tied to a user. It can be used to identify a device across orgs."},"osVersion":{"type":"string"},"clientInstanceBundleId":{"type":"string"},"platform":{"type":"string","enum":["ANDROID","IOS"]},"manufacturer":{"type":"string","example":["APPLE","Google"]},"deviceAttestation":{"type":"object"},"clientInstanceVersion":{"type":"string"},"clientInstanceDeviceSdkVersion":{"type":"string"},"model":{"type":"string","example":["iPhone 14","Pixel 4"]},"displayName":{"type":"string","description":"The device's display name"},"udid":{"type":"string"}},"required":["clientInstanceKey","clientInstanceBundleId","clientInstanceVersion","clientInstanceDeviceSdkVersion","osVersion","platform","displayName"]},"methods":{"type":"object","required":["push"],"properties":{"push":{"type":"object","required":["pushToken","keys"],"properties":{"apsEnvironment":{"type":"string","description":"Target APS type that application registers to. Required for iOS enrollments.","enum":["PRODUCTION","DEVELOPMENT"]},"pushToken":{"type":"string"},"keys":{"type":"object","required":["proofOfPossession"],"properties":{"proofOfPossession":{"$ref":"#/components/schemas/KeyObject"},"userVerification":{"$ref":"#/components/schemas/KeyObject"},"capabilities":{"$ref":"#/components/schemas/AppAuthenticatorMethodCapabilities"}}}}}}}},"required":["authenticatorId","device","methods"]}},"components/schemas/AppAuthenticatorMethodCapabilities":{"id":"components/schemas/AppAuthenticatorMethodCapabilities","kind":"json-schema","title":"AppAuthenticatorMethodCapabilities","data":{"type":"object","properties":{"transactionTypes":{"type":"array","items":{"type":"string","enum":["LOGIN","CIBA"]}}}}},"components/schemas/Authenticator":{"id":"components/schemas/Authenticator","kind":"json-schema","title":"Authenticator","data":{"description":"A specific authenticator of the current user","type":"object","properties":{"enrollable":{"type":"boolean","description":"Whether the authenticator allows new enrollments","readOnly":true},"id":{"type":"string","description":"The unique identifier of the authenticator","readOnly":true},"key":{"$ref":"#/components/schemas/AuthenticatorKey"},"logo":{"type":"object","readOnly":true,"properties":{"uri":{"type":"string","description":"The URI of the custom authenticator logo","readOnly":true}}},"name":{"type":"string","description":"The display name of the authenticator","readOnly":true},"_embedded":{"type":"object","readOnly":true,"properties":{"enrollments":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticatorEnrollment"}}}},"_links":{"type":"object","readOnly":true,"properties":{"self":{"$ref":"#/components/schemas/HrefObject"},"enroll":{"$ref":"#/components/schemas/HrefObject"},"enrollments":{"$ref":"#/components/schemas/HrefObject"}}}}}},"components/schemas/AuthenticatorEnrollment":{"id":"components/schemas/AuthenticatorEnrollment","kind":"json-schema","title":"AuthenticatorEnrollment","data":{"description":"Authenticator enrollment of the current user","type":"object","properties":{"canChangePassword":{"type":"boolean","description":"Whether the user has permission to perform a password change operation as determined by their password policy","readOnly":true},"canReset":{"type":"boolean","description":"Whether the authenticator enrollment can be reset","readOnly":true,"deprecated":true},"canResetPassword":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the user has permission to perform a password reset operation, as determined by their password policy and password source. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canResetPassword"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false, the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-myaccount/myaccount/tag/Authenticators/#tag/Authenticators/operation/listAuthenticators!c=200&path=_embedded/enrollments/_links/modify&t=response"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"modify"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object isn't returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}]},"canUnenroll":{"type":"boolean","description":"Whether the authenticator can be unenrolled","readOnly":true},"created":{"type":"string","description":"The date when the authenticator enrollment was created","readOnly":true},"id":{"type":"string","description":"The unique identifier of the authenticator enrollment","readOnly":true},"lastChallenged":{"type":"string","description":"The date when the authenticator enrollment was last challenged","readOnly":true},"name":{"type":"string","description":"The display name of the authenticator enrollment"},"nickname":{"type":"string","description":"A customizable name for the authenticator enrollment"},"profile":{"type":"object","description":"The fields specific to an authenticator enrollment that may not be common across all authenticators","readOnly":true},"_links":{"type":"object","readOnly":true,"properties":{"self":{"$ref":"#/components/schemas/HrefObject"},"authenticator":{"$ref":"#/components/schemas/HrefObject"},"modify":{"$ref":"#/components/schemas/HrefObject"},"unenroll":{"$ref":"#/components/schemas/HrefObject"}}}}}},"components/schemas/AuthenticatorKey":{"id":"components/schemas/AuthenticatorKey","kind":"json-schema","title":"AuthenticatorKey","data":{"description":"An Okta server key that identifies the authenticator","type":"string","enum":["custom_app","custom_otp","duo","external_idp","google_otp","okta_email","okta_password","okta_verify","onprem_mfa","phone_number","rsa_token","security_question","symantec_vip","webauthn","yubikey_token","okta_verify_totp","okta_verify_push","okta_verify_fastpass"],"readOnly":true}},"components/schemas/CreateWebAuthnRequest":{"id":"components/schemas/CreateWebAuthnRequest","kind":"json-schema","title":"CreateWebAuthnRequest","data":{"type":"object","properties":{"attestation":{"type":"string","example":"o2NmbXRoZmlk...","description":"JSON-serialized data that contains the authenticator data and attestation statement"},"clientData":{"type":"string","example":"eyJjaGFsbGVuZ...","description":"JSON-serialized data that's passed to the Passkey (FIDO2 WebAuthn) authenticator by the client to generate the WebAuthn credentials"},"clientExtensions":{"type":"string","example":"{\"credProps\":{\"rk\":true}}","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON-serialized data that contains "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.w3.org/TR/webauthn-2/#sctn-extensions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticator extensions"},"children":[]}]}]}]}]},"transports":{"type":"string","example":"[\"internal\"]","description":"JSON-serialized data that contains the transport values that the authenticator is believed to support"}},"required":["clientData","attestation"]}},"components/schemas/Email":{"id":"components/schemas/Email","kind":"json-schema","title":"Email","data":{"description":"Email object","type":"object","properties":{"id":{"type":"string","description":"The email ID of the caller","minLength":1,"readOnly":true},"profile":{"type":"object","description":"Defines the email address on the profile","required":["email"],"properties":{"email":{"type":"string","description":"Email address of the user","minLength":1}}},"roles":{"type":"array","description":"Defines the role of the email","items":{"type":"string","enum":["PRIMARY","SECONDARY"]}},"status":{"type":"string","description":"The email status of the caller","minLength":1,"readOnly":true,"enum":["VERIFIED","UNVERIFIED"]},"_links":{"type":"object","description":"Discoverable resources related to the caller's email","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["GET","DELETE","PUT"]}}}}}},"challenge":{"type":"object","description":"Link to the resource (challenge)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","POST","PUT"]}}}}}},"verify":{"type":"object","description":"Link to the resource (verify)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","POST","PUT"]}}}}}},"poll":{"type":"object","description":"Link to the resource (poll)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","POST","PUT"]}}}}}}}}},"required":["id","status","profile","roles"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"description":"Standard API error object","type":"object","properties":{"errorCauses":{"type":"array","description":"(Optional) Further information about what caused this error","items":{"type":"object","properties":{"errorSummary":{"type":"string","description":"A natural language explanation of the error","example":"Bad request because XYZ is missing.","readOnly":true}}}},"errorCode":{"type":"string","description":"A code that is associated with this error type","example":"E0000001","readOnly":true},"errorId":{"type":"string","description":"A unique identifier for this error. This can be used by Okta Support to help with troubleshooting.","example":"oaeWGQKoQHeQmy0u8w8bPwi_Q","readOnly":true},"errorLink":{"type":"string","description":"A link to documentation with a more detailed explanation of the error (not yet implemented and is currently the same value as the 'errorCode')","example":"E0000001","readOnly":true},"errorSummary":{"type":"string","description":"A natural language explanation of the error","example":"Bad request because XYZ is missing.","readOnly":true}}}},"components/schemas/Error406":{"id":"components/schemas/Error406","kind":"json-schema","title":"Error406","data":{"description":"Not Acceptable error object","type":"object","properties":{"errorCauses":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Missing or incorrect "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header"},"children":[]}]}]}],"readOnly":true},"errorCode":{"type":"string","description":"E0000149","readOnly":true},"errorId":{"type":"string","description":"A unique identifier for this error. This can be used by Okta Support to help with troubleshooting.","example":"sampleH3iLB6bpBcbnV9E09Fy","readOnly":true},"errorLink":{"type":"string","description":"E0000149","readOnly":true},"errorSummary":{"type":"string","description":"The HTTP request is not acceptable","readOnly":true}}}},"components/schemas/HrefObject":{"id":"components/schemas/HrefObject","kind":"json-schema","title":"Link object","data":{"title":"Link object","type":"object","properties":{"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"$ref":"#/components/schemas/HttpMethod"}}}},"href":{"type":"string","description":"Link URI"},"name":{"type":"string","description":"Link name"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The media type of the link. If omitted, it is implicitly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["href"],"readOnly":true}},"components/schemas/HttpMethod":{"id":"components/schemas/HttpMethod","kind":"json-schema","title":"HttpMethod","data":{"type":"string","enum":["DELETE","GET","POST","PUT"]}},"components/schemas/KeyEC":{"id":"components/schemas/KeyEC","kind":"json-schema","title":"KeyEC","data":{"type":"object","properties":{"crv":{"type":"string","enum":["P-256"]},"kid":{"type":"string","description":"The unique identifier of the key"},"kty":{"type":"string","enum":["EC"],"description":"The type of public key"},"okta:kpr":{"type":"string","enum":["HARDWARE","SOFTWARE"]},"x":{"type":"string","description":"The public x coordinate for the elliptic curve point"},"y":{"type":"string","description":"The public y coordinate for the elliptic curve point"}},"required":["x","y","kty","okta:kpr","crv","kid"]}},"components/schemas/KeyObject":{"id":"components/schemas/KeyObject","kind":"json-schema","title":"KeyObject","data":{"oneOf":[{"$ref":"#/components/schemas/KeyEC"},{"$ref":"#/components/schemas/KeyRSA"}],"type":"object"}},"components/schemas/KeyRSA":{"id":"components/schemas/KeyRSA","kind":"json-schema","title":"KeyRSA","data":{"type":"object","properties":{"e":{"type":"string","description":"The key exponent of a RSA key"},"kid":{"type":"string","description":"The unique identifier of the key"},"kty":{"type":"string","enum":["RSA"],"description":"The type of public key"},"n":{"type":"string","description":"The modulus of the RSA key"},"okta:kpr":{"type":"string","enum":["HARDWARE","SOFTWARE"]}},"required":["n","e","kty","okta:kpr","kid"]}},"components/schemas/OktaApplication":{"id":"components/schemas/OktaApplication","kind":"json-schema","title":"OktaApplication","data":{"description":"Okta apps list","type":"object","properties":{"displayName":{"type":"string","description":"The display name of the app","minLength":1,"readOnly":true},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the app"},"children":[]}]}]}],"minLength":1,"readOnly":true},"name":{"type":"string","description":"The name of the app","minLength":1,"readOnly":true}}}},"components/schemas/Organization":{"id":"components/schemas/Organization","kind":"json-schema","title":"Organization","data":{"description":"Org object","type":"object","properties":{"helpLink":{"type":"string","description":"The URL of the org's help resources","readOnly":true},"name":{"type":"string","description":"The name of the org","minLength":1,"readOnly":true},"supportEmail":{"type":"string","description":"The email address of the org support contact","readOnly":true},"url":{"type":"string","description":"The URL of the org","minLength":1,"readOnly":true},"_links":{"type":"object","description":"Discoverable resources related to the org","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["GET"]}}}}}}}}}}},"components/schemas/PasswordResponse":{"id":"components/schemas/PasswordResponse","kind":"json-schema","title":"PasswordResponse","data":{"description":"Password response object","type":"object","properties":{"created":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If password is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns the date when password was first enrolled"},"children":[]}]}]}]},"id":{"type":"string","minLength":1,"readOnly":true},"lastUpdated":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If password is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", returns the date when password was last updated"},"children":[]}]}]}]},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_ENROLLED"},"children":[]}]}]}]},"_links":{"type":"object","description":"Discoverable resources related to the password","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","PUT"]}}}}}}}}}}},"components/schemas/Phone":{"id":"components/schemas/Phone","kind":"json-schema","title":"Phone","data":{"description":"Phone object","type":"object","properties":{"id":{"type":"string","description":"The phone ID of the caller","minLength":1,"readOnly":true},"profile":{"type":"object","description":"Defines the phone number on the profile","required":["phoneNumber"],"properties":{"phoneNumber":{"type":"string","description":"The phone number on the profile","minLength":1}}},"status":{"type":"string","description":"The phone status of the caller","enum":["VERIFIED","UNVERIFIED"],"minLength":1,"readOnly":true},"_links":{"type":"object","description":"Discoverable resources related to the caller's phone","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["GET","DELETE","PUT"]}}}}}},"challenge":{"type":"object","description":"Link to the resource (challenge)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","POST","PUT"]}}}}}},"verify":{"type":"object","description":"Link to the resource (verify)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","POST","PUT"]}}}}}}}}},"required":["id","status","profile"]}},"components/schemas/Profile":{"id":"components/schemas/Profile","kind":"json-schema","title":"Profile","data":{"description":"Profile object based on the user's directory profile schema (based on UD)","type":"object","properties":{"createdAt":{"type":"string","description":"The timestamp of the creation of the caller's account","format":"date-time","readOnly":true},"modifiedAt":{"type":"string","description":"The timestamp of the last update to the caller's account","format":"date-time","readOnly":true},"profile":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The properties defined in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user profile schema"},"children":[]}]}]}]}]},"_links":{"type":"object","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","format":"uri","readOnly":true}}},"describedBy":{"type":"object","description":"Link to the resource (describedBy)","properties":{"href":{"type":"string","description":"Link URI","format":"uri","readOnly":true}}}}}}}},"components/schemas/PushNotificationChallenge":{"id":"components/schemas/PushNotificationChallenge","kind":"json-schema","title":"PushNotificationChallenge","data":{"description":"Push notification challenge request object for an app authenticator","type":"object","properties":{"challenge":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT issued by Okta at the time of challenging for a push notification."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This based64-encoded JWT consists of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwtheader"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT header"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengerequestjwt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT payload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"payloadVersion":{"type":"string","enum":["IDXv1"]}}}},"components/schemas/PushNotificationChallengeRequestJwt":{"id":"components/schemas/PushNotificationChallengeRequestJwt","kind":"json-schema","title":"PushNotificationChallengeRequestJwt","data":{"x-tags":["AppAuthenticator"],"description":"JSON Web Token payload constructed by Okta for the push notification challenge request JWT","type":"object","properties":{"appInstanceName":{"type":"string","description":"Friendly name of the application for the authentication request"},"aud":{"type":"string","description":"Audience (maps to the application ID)"},"authenticatorEnrollmentId":{"type":"string","description":"ID of the app authenticator enrollment","example":"pfd7rzcmvlhmE0Y1w0g4"},"authorizationServerId":{"type":"string","description":"ID of the authorization server that signed the challenge request"},"challengeContext":{"type":"object","properties":{"clientOS":{"type":"string","description":"OS of the client making the request"},"clientLocation":{"type":"string","description":"Location of the request"},"transactionTime":{"type":"string","description":"Time the challenge request was created"},"transactionType":{"type":"string","description":"Indicates if the request is CIBA or LOGIN","enum":["CIBA","LOGIN"]},"bindingMessage":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is CIBA, this message must be shown to the user"},"children":[]}]}]}]}}},"exp":{"type":"string","description":"Expiration time of token (UNIX timestamp)"},"iat":{"type":"string","description":"Issuing time of token (UNIX timestamp)"},"iss":{"type":"string","description":"Issuer (maps to the org URL)"},"jti":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token ID (matches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"method":{"type":"string","description":"Method type requested for the response","enum":["push"],"example":"push"},"methodEnrollmentId":{"type":"string","description":"ID of the push method enrollment","example":"opf6aeq9U2hoM8aqO0w5"},"nonce":{"type":"string","description":"Randomly generated nonce value"},"orgId":{"type":"string","description":"ID of the organization"},"signals":{"type":"array","description":"Array of string values describing client signals requested for collection"},"transactionId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transaction ID (matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"challengeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter)"},"children":[]}]}]}]},"userId":{"type":"string","description":"ID of the user being challenged"},"userMediation":{"type":"string","description":"Indicates if user mediation is required","enum":["NONE","OPTIONAL","REQUIRED"],"x-enumDescriptions":{"NONE":"User interaction isn't required by the client during authentication.","OPTIONAL":"The client can decide to interact with the user or not.","REQUIRED":"The client must interact with the user. If a biometrics prompt occurs during user verification, additional consent prompt isn't shown by the client."},"example":"REQUIRED"},"userVerification":{"type":"string","description":"Indicates if user verification (biometrics) is used in the response","enum":["NONE","DISCOURAGED","PREFERRED","REQUIRED"],"x-enumDescriptions":{"NONE":"The client doesn't require any user verification as part of the authentication flow.","DISCOURAGED":"The client prefers a proof of possession flow without user interaction. However, the client can prompt for user verification if it allows for a better user experience.","PREFERRED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client user verification prompt is preferred. If the user verification key is unavailable, the client can use the proof of possession. In this situation, Okta recommends that the client send UV_TEMPORARILY_UNAVAILABLE or UV_PERMANENTLY_UNAVAILABLE in the challenge response's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userConsent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"REQUIRED":"The client must prompt for user verification and otherwise fail silently without user interaction."},"example":"REQUIRED"},"ver":{"type":"integer","description":"Version of the JWT (supported value: 0)","example":0},"verificationUri":{"type":"string","description":"The expected endpoint posted by the client for the challenge response"}}}},"components/schemas/PushNotificationChallengeRequestJwtHeader":{"id":"components/schemas/PushNotificationChallengeRequestJwtHeader","kind":"json-schema","title":"PushNotificationChallengeRequestJwtHeader","data":{"x-tags":["AppAuthenticator"],"description":"JSON Web Token header used for the push notification challenge request JWT","type":"object","properties":{"alg":{"type":"string","description":"Signing algorithm used","example":"RS256"},"kid":{"type":"string","description":"Signing key ID that matches the key ID used by the authorization server","example":"“seD0hUMrcpFtlVVTmkDyJ0mGxlEygWEZ42ts9z4ih9M”"},"typ":{"type":"string","description":"Type of token","enum":["okta-pushbind+jwt"],"example":"okta-pushbind+jwt"}}}},"components/schemas/PushNotificationChallengeResponseJwt":{"id":"components/schemas/PushNotificationChallengeResponseJwt","kind":"json-schema","title":"PushNotificationChallengeResponseJwt","data":{"x-tags":["AppAuthenticator"],"description":"JSON Web Token payload used for the push notification challenge response JWT","type":"object","properties":{"aud":{"type":"string","description":"Audience (matches the org URL)"},"challengeResponseContext":{"type":"object","description":"Object describing the response context","required":["userConsent"],"properties":{"userConsent":{"type":"string","description":"Type of user consent","enum":["NONE","APPROVED_CONSENT_PROMPT","APPROVED_USER_VERIFICATION","CANCELLED_USER_VERIFICATION","DENIED_CONSENT_PROMPT","UV_TEMPORARILY_UNAVAILABLE","UV_PERMANENTLY_UNAVAILABLE","USER_ABANDONED"],"x-enumDescriptions":{"NONE":"There was no interaction with the end user as part of the authentication","APPROVED_CONSENT_PROMPT":"The user approved the consent prompt","APPROVED_USER_VERIFICATION":"The user approved the user verification by providing biometrics or a PIN","CANCELLED_USER_VERIFICATION":"The user cancelled user verification by rejecting the biometrics prompt","DENIED_CONSENT_PROMPT":"The user rejected the consent prompt","UV_TEMPORARILY_UNAVAILABLE":"The client currently can't access the user verification key","UV_PERMANENTLY_UNAVAILABLE":"The client permanently lost access to the user verification key","USER_ABANDONED":"The user cancelled user verification by closing the biometrics prompt"},"example":"APPROVED_CONSENT_PROMPT"},"transactionType":{"type":"string","description":"Type of transaction","enum":["LOGIN","CIBA"],"example":"LOGIN"}}},"deviceSignals":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON dictionary with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys (and their values) requested in the challenge request"},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"ID of the device"},"isHardwareProtectionEnabled":{"type":"boolean","description":"Indicates whether the Android device supports a hardware keystore or if the iOS device supports Secure Enclave"},"model":{"type":"string","description":"The device type or design","example":"iPhone"},"manufacturer":{"type":"string","description":"The vendor that created the physical device","example":"Apple"},"displayName":{"type":"string","description":"The display name of the device"},"platform":{"type":"string","description":"The device operating system","enum":["ANDROID","IOS"],"example":"IOS"},"osVersion":{"type":"string","description":"The device operating system software version","example":"11.4"},"clientInstanceId":{"type":"string","description":"Key ID of the client instance key"},"clientInstanceBundleId":{"type":"string","description":"ID of the application bundle"},"clientInstanceVersion":{"type":"string","description":"Application version"},"secureHardwarePresent":{"type":"boolean","description":"Indicates if secure hardware is present"},"screenLockType":{"type":"string","description":"Screen lock type set on the device","enum":["NONE","PASSCODE","BIOMETRIC"],"x-enumDescriptions":{"NONE":"No passcode is set on the device","PASSCODE":"Only a passcode or password is set on the device (biometrics aren't set up)","BIOMETRIC":"Passcode and biometrics are set on the device"},"example":"BIOMETRIC"},"diskEncryptionType":{"type":"string","description":"Disk encryption type of the device profile","enum":["NONE","FULL","USER"],"x-enumDescriptions":{"NONE":"No encryption has been set","FULL":"The disk is fully encrypted","USER":"The encryption key is tied to the user or profile (Android only)"},"example":"FULL"}}},"exp":{"type":"string","description":"Expiration time of token (UNIX timestamp)"},"iat":{"type":"string","description":"Issuing time of token (UNIX timestamp)"},"iss":{"type":"string","description":"Issuer (matches the app authenticator enrollment ID)"},"jti":{"type":"string","description":"Randomly generated ID for every response"},"keyType":{"type":"string","description":"Type of key used to sign the JWT","enum":["proofOfPossession","userVerification"],"example":"proofOfPossession"},"methodEnrollmentId":{"type":"string","description":"ID of the push method enrollmnet","example":"opf6aeq9U2hoM8aqO0w5"},"nbf":{"type":"string","description":"Token isn't valid before this time (UNIX timestamp)"},"nonce":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nonce"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the challenge request"},"children":[]}]}]}]},"sub":{"type":"string","description":"Subject (matches the user ID)"},"tx":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matches the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transactionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the challenge request"},"children":[]}]}]}]}},"required":["iss","sub","aud","jti","iat","exp","nbf","methodEnrollmentId","tx","nonce","keyType","challengeResponseContext"]}},"components/schemas/PushNotificationChallengeResponseJwtHeader":{"id":"components/schemas/PushNotificationChallengeResponseJwtHeader","kind":"json-schema","title":"PushNotificationChallengeResponseJwtHeader","data":{"x-tags":["AppAuthenticator"],"description":"JSON Web Token header used for the push notification challenge response JWT","type":"object","properties":{"alg":{"type":"string","description":"Signing algorithm used","example":"RS256"},"kid":{"type":"string","description":"Signing key ID that matches the key ID used during the authenticator enrolment flow","example":"“7fbc27fd-e3df-4522-86bf-1930110256ad”"},"typ":{"type":"string","description":"Type of token","enum":["okta-pushbind+jwt"],"example":"okta-pushbind+jwt"}},"required":["kid","typ","alg"]}},"components/schemas/PushNotificationVerification":{"id":"components/schemas/PushNotificationVerification","kind":"json-schema","title":"PushNotificationVerification","data":{"description":"Push notification challenge response object for an app authenticator","type":"object","properties":{"challengeResponse":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT issued by the app authenticator at the time of push notification verification"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This based64-encoded JWT consists of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwtheader"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT header"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-myaccount/myaccount/appauthenticator/pushnotificationchallengeresponsejwt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT payload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"method":{"type":"string","enum":["push"]}}}},"components/schemas/Schema":{"id":"components/schemas/Schema","kind":"json-schema","title":"Schema","data":{"title":"Schema","description":"Describes a user's directory profile schema (based on UD)","type":"object","properties":{"properties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The properties defined in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Schema/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"user profile schema"},"children":[]}]}]}]}],"readOnly":true},"_links":{"type":"object","description":"Discoverable resources related to the user's directory profile","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","format":"uri","readOnly":true}}},"user":{"type":"object","description":"Link to the resource (user)","properties":{"href":{"type":"string","description":"Link URI","format":"uri","readOnly":true}}}}}}}},"components/schemas/UpdateAppAuthenticatorEnrollmentRequest":{"id":"components/schemas/UpdateAppAuthenticatorEnrollmentRequest","kind":"json-schema","title":"UpdateAppAuthenticatorEnrollmentRequest","data":{"type":"object","properties":{"methods":{"type":"object","properties":{"push":{"type":"object","properties":{"pushToken":{"type":"string"},"keys":{"type":"object","properties":{"userVerification":{"$ref":"#/components/schemas/KeyObject","nullable":true}}},"capabilities":{"type":"object","$ref":"#/components/schemas/AppAuthenticatorMethodCapabilities"}}}}}}}},"components/schemas/UpdateAuthenticatorEnrollmentRequest":{"id":"components/schemas/UpdateAuthenticatorEnrollmentRequest","kind":"json-schema","title":"UpdateAuthenticatorEnrollmentRequest","data":{"type":"object","properties":{"nickname":{"type":"string"}}}},"components/schemas/WebAuthn":{"id":"components/schemas/WebAuthn","kind":"json-schema","title":"WebAuthn","data":{"description":"Passkey (FIDO2 WebAuthn) enrollment object","type":"object","properties":{"created":{"type":"string","description":"Date when the Passkey (FIDO2 WebAuthn) authenticator was first enrolled"},"credentialId":{"type":"string","description":"Unique identifier of the specific WebAuthn credential"},"id":{"type":"string","description":"Unique identifier of the Passkey (FIDO2 WebAuthn) enrollment","minLength":1,"readOnly":true},"key":{"type":"string","description":"Authenticator key"},"lastUpdated":{"type":"string","description":"Date when the Passkey (FIDO2 WebAuthn) enrollment was last updated"},"name":{"type":"string","description":"Authenticator name"},"status":{"type":"string","description":"Enrollment status","enum":["ACTIVE","SUSPENDED","EXPIRED"],"minLength":1,"readOnly":true},"type":{"type":"string","description":"Authenticator type","enum":["security_key"]},"_links":{"type":"object","description":"Discoverable resources related to the Passkey (FIDO2 WebAuthn) enrollment","properties":{"self":{"type":"object","description":"Link to the resource (self)","properties":{"href":{"type":"string","description":"Link URI","minLength":1},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET"]}}}}}}}}}}},"components/schemas/WebAuthnRegistrationOptions":{"id":"components/schemas/WebAuthnRegistrationOptions","kind":"json-schema","title":"WebAuthnRegistrationOptions","data":{"type":"object","properties":{"expiresAt":{"type":"string","description":"Date and time when the challenge expires"},"options":{"type":"object","description":"WebAuthn registration options for the Passkey (FIDO2 WebAuthn) authenticator","properties":{"rp":{"type":"object","description":"Public key credential that's associated with the RP","properties":{"name":{"type":"string","description":"Name of the RP"}}},"user":{"type":"object","description":"The user for whom the credential is created","properties":{"displayName":{"type":"string","description":"User's display name"},"name":{"type":"string","description":"Username of the user"},"id":{"type":"string","description":"Unique identifier of the user"}}},"pubKeyCredParams":{"type":"array","description":"Array of public key credential parameters","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the credential","enum":["public-key"]},"alg":{"type":"integer","description":"The algorithm of the cryptographic signature"}}}},"challenge":{"type":"string","description":"Cryptographic nonce challenge that's signed by the authenticator"},"attestation":{"type":"string","description":"Specifies how much information about the authenticator is included in the attestation and the method for how that information is shared","enum":["none","indirect","direct","enterprise"],"x-enumDescriptions":{"none":"No attestation is requested","indirect":"Attestation is requested, but the client doesn't need to verify the attestation","direct":"Attestation is requested, and the client needs to verify the attestation","enterprise":"Attestation is requested, and the client needs to verify the attestation. The client also needs to verify that the authenticator is managed by the enterprise."}},"authenticatorSelection":{"type":"object","description":"Select the appropriate authenticators to create","properties":{"userVerification":{"type":"string","description":"Specifies whether stronger user verification is required when authenticating or enrolling a new authenticator","enum":["required","preferred","discouraged"],"x-enumDescriptions":{"required":"Users are always prompted for user verification","preferred":"Users are prompted for user verification, if the authenticator supports it","discouraged":"Users aren't prompted for user verification"}},"residentKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the RP wants to create a client-side discoverable credential. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"residentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"preferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then a discoverable credential is created and users can authenticate without the server"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"needing to send the credential ID. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"residentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discouraged"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then a non-discoverable credential is created and users must authenticate with the server that sends the credential ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"residentKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only returned if you have enabled Passkey Autofill as an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/release-lifecycle/#early-access-ea"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Early Access Self-Service"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature."},"children":[]}]}]}]}],"enum":["required","preferred","discouraged"]},"requireResidentKey":{"type":"boolean","description":"Indicates if the authenticator must support resident keys"}}},"u2fParams":{"type":"object","description":"Supports compatibility with a universal second factor (U2F)","properties":{"appid":{"type":"string","description":"Full origin of the request that's used by the U2F protocol"}}},"excludeCredentials":{"type":"array","description":"List of existing credentials on the same authenticator device that can't be overwritten by a new credential","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the credential","enum":["public-key"]},"id":{"type":"string","description":"Credential ID"}}}}}},"_links":{"type":"object","description":"Discoverable resources related to the WebAuthn registration challenge","properties":{"enroll":{"type":"object","description":"Link to verify the challenge and complete the enrollment","properties":{"href":{"type":"string","description":"Link URI"},"hints":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["POST"]}}}}}}}}}}},"schema_1487":{"kind":"json-schema","data":{"type":"string","example":"application/json; okta-version=1.0.0"},"id":"schema_1487"},"schema_1488":{"kind":"json-schema","data":{"type":"string","example":"ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW"},"id":"schema_1488"},"schema_1489":{"kind":"json-schema","data":{"type":"string","example":"pfd7rzcmvlhmE0Y1w0g4"},"id":"schema_1489"},"schema_1490":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PushNotificationChallenge"}},"id":"schema_1490"},"schema_1491":{"kind":"json-schema","data":{"type":"string","example":"enrollments","enum":["enrollments","requirements"],"x-enumDescriptions":{"enrollments":"Returns the list of authenticator enrollments associated with the authenticator","requirements":"Returns the list of password requirements associated with the authenticator"}},"id":"schema_1491"},"schema_1492":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Authenticator"}},"id":"schema_1492"},"schema_1493":{"kind":"json-schema","data":{"type":"string","example":"aut9gnvcjUHIWb37J0g4"},"id":"schema_1493"},"schema_1494":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticatorEnrollment"}},"id":"schema_1494"},"schema_1495":{"kind":"json-schema","data":{"type":"string","example":"ufs2bysphxKODSZKWVCT"},"id":"schema_1495"},"schema_1496":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"id":"schema_1496"},"schema_1497":{"kind":"json-schema","data":{"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.\n","writeOnly":true},"role":{"type":"string","enum":["PRIMARY","SECONDARY"],"example":"PRIMARY","writeOnly":true}},"required":["profile"]},"id":"schema_1497"},"schema_1498":{"kind":"json-schema","data":{"type":"string","example":"69dca29c2d8dbb0dca14395ccdb92317"},"id":"schema_1498"},"schema_1499":{"kind":"json-schema","data":{"type":"string","example":"00T196qTp3LIMZQ0L0g3"},"id":"schema_1499"},"schema_1500":{"kind":"json-schema","data":{"type":"object","properties":{"state":{"type":"string","example":"JPcFLTwOq7UvoFtmRd3EnyQwsR0PbDSI","writeOnly":true,"description":"(Optional) The state parameter that contains the state of the client"}},"required":["state"]},"id":"schema_1500"},"schema_1501":{"kind":"json-schema","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"required":["allow"],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["GET"]}}}}}}}}},"required":["id","status","expiresAt","profile","_links"]},"id":"schema_1501"},"schema_1502":{"kind":"json-schema","data":{"type":"string","example":"x1MDGzUb"},"id":"schema_1502"},"schema_1503":{"kind":"json-schema","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"required":["allow"],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["DELETE","GET","POST","PUT"]}}}}}}}}},"required":["id","status","expiresAt","profile","_links"]},"id":"schema_1503"},"schema_1504":{"kind":"json-schema","data":{"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"]},"id":"schema_1504"},"schema_1505":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/OktaApplication"}},"id":"schema_1505"},"schema_1506":{"kind":"json-schema","data":{"type":"object","properties":{"profile":{"type":"object","description":"Defines the password on the profile","required":["password"],"properties":{"password":{"type":"string","example":"Abcd12345","writeOnly":true}}}},"required":["profile"]},"id":"schema_1506"},"schema_1507":{"kind":"json-schema","data":{"type":"object","properties":{"oldPassword":{"type":"string","example":"Abcd1234"},"newPassword":{"type":"string","example":"Abcd12345"}},"required":["oldPassword","newPassword"]},"id":"schema_1507"},"schema_1508":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Phone"}},"id":"schema_1508"},"schema_1509":{"kind":"json-schema","data":{"type":"object","properties":{"profile":{"type":"object","description":"Defines the phone number on the profile","properties":{"phoneNumber":{"type":"string","description":"The newly added phone number","example":"555-555-5555"}}},"sendCode":{"type":"boolean","default":true,"description":"Whether to send a challenge to the newly added phone"},"method":{"type":"string","enum":["SMS","CALL"],"example":"SMS","writeOnly":true,"description":"The method of the challenge sent to the newly added phone. Applicable when sendCode is true."}},"required":["profile"]},"id":"schema_1509"},"schema_1510":{"kind":"json-schema","data":{"type":"string","example":"sms10ltpSdwXJCem80g4"},"id":"schema_1510"},"schema_1511":{"kind":"json-schema","data":{"type":"string","example":"sms18vtfKgzqDhNqP0g4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the phone. Obtain the ID of the phone through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when adding a new phone."},"children":[]}]}]}]},"id":"schema_1511"},"schema_1512":{"kind":"json-schema","data":{"type":"object","properties":{"method":{"type":"string","example":"SMS","description":"The method with which the challenge should be sent","enum":["SMS","CALL"],"writeOnly":true},"retry":{"type":"boolean","description":"Indicates whether this is a normal challenge or retry","default":false}},"required":["method"]},"id":"schema_1512"},"schema_1513":{"kind":"json-schema","data":{"type":"object","properties":{"_links":{"type":"object","description":"Discoverable resources related to the phone challenge","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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes the allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"required":["allow"],"properties":{"allow":{"type":"array","items":{"type":"string","enum":["GET"]}}}}}}}}}},"id":"schema_1513"},"schema_1514":{"kind":"json-schema","data":{"type":"string","example":"sms18vtfKgzqDhNqP0g4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The phone ID. Obtain the ID of the phone through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /idp/myaccount/phones"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when adding a new phone."},"children":[]}]}]}]},"id":"schema_1514"},"schema_1515":{"kind":"json-schema","data":{"type":"object","properties":{"verificationCode":{"type":"string","example":"492592","format":"password","description":"A six-digit verification code that the user receives through SMS or CALL","writeOnly":true}},"required":["verificationCode"]},"id":"schema_1515"},"schema_1516":{"kind":"json-schema","data":{"type":"object","properties":{"profile":{"type":"object","description":"The properties defined in the schema"}}},"id":"schema_1516"},"schema_1517":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_1517"},"schema_1518":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_1518"},"schema_1519":{"kind":"json-schema","data":{"type":"string","example":"fwfn3c3rryqStmyp20g4"},"id":"schema_1519"}},"exampleStore":{"components/examples/AuthenticatorExampleExternalIdp":{"id":"components/examples/AuthenticatorExampleExternalIdp","value":{"id":"autt5i9pIn7WMBUht0g4","key":"external_idp","name":"External IdP OIDC","enrollable":true,"logo":{"uri":"https://cdn.okta1.com/bc/globalFileStoreRecord?id=gfst5lrCKbaYgrZAX0g4"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autt5i9pIn7WMBUht0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autt5i9pIn7WMBUht0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autt5i9pIn7WMBUht0g4/enrollments","hints":{"allow":["GET"]}}}},"summary":"External IdP authenticator"},"components/examples/AuthenticatorExampleOktaVerifyFastpass":{"id":"components/examples/AuthenticatorExampleOktaVerifyFastpass","value":{"id":"autf5jzpIaAbmXXQ30g4","key":"okta_verify_fastpass","name":"Okta Verify FastPass","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments","hints":{"allow":["GET"]}}}},"summary":"Okta Verify FastPass authenticator"},"components/examples/AuthenticatorExampleOktaVerifyPush":{"id":"components/examples/AuthenticatorExampleOktaVerifyPush","value":{"id":"autf5jyYtSkbEvFpv0g4","key":"okta_verify_push","name":"Okta Verify Push","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments","hints":{"allow":["GET"]}}}},"summary":"Okta Verify Push authenticator"},"components/examples/AuthenticatorExampleOktaVerifyTotp":{"id":"components/examples/AuthenticatorExampleOktaVerifyTotp","value":{"id":"autf5jxPRRciM4mXb0g4","key":"okta_verify_totp","name":"Okta Verify TOTP","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments","hints":{"allow":["GET"]}}}},"summary":"Okta Verify TOTP authenticator"},"components/examples/AuthenticatorExamplePassword":{"id":"components/examples/AuthenticatorExamplePassword","value":{"id":"aut3jiaiZukD4Ta0Z0g5","key":"okta_password","name":"Okta password","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments","hints":{"allow":["GET"]}},"requirements":{"href":"https://sampleorg.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}},"summary":"Password authenticator"},"components/examples/AuthenticatorExampleSecurityKey":{"id":"components/examples/AuthenticatorExampleSecurityKey","value":{"id":"aut65i8bdXk90tyfr0q7","key":"webauthn","name":"Security Key or Biometric","enrollable":false,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut65i8bdXk90tyfr0q7","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut65i8bdXk90tyfr0q7/enrollments","hints":{"allow":["GET"]}}}},"summary":"Security key authenticator"},"components/examples/CreateAppAuthenticatorEnrollment":{"id":"components/examples/CreateAppAuthenticatorEnrollment","value":{"authenticatorId":"aut12i8bdXk90NIfr0q5","device":{"secureHardwarePresent":true,"clientInstanceKey":{"x":"O0N1H3AIXj5p5cpQx5RUzowIRz1iPnheo7SbEC-CtFw","y":"Cea3KAFqsyxqPni2QJ6LjjqgRKgRHpsVzkNazd3m8To","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"DF47DEE2-D1B0-40B6-BEB7-09134CC4A19B"},"osVersion":"14.3","clientInstanceBundleId":"com.company.authenticatorApp","platform":"IOS","manufacturer":"APPLE","deviceAttestation":{},"clientInstanceVersion":"6.4.0","clientInstanceDeviceSdkVersion":"DeviceSDK 1.0.0","model":"iPhone","displayName":"My device name","udid":"4956095A-D99E-4A4E-A6DC-9E63E5978722"},"methods":{"push":{"apsEnvironment":"DEVELOPMENT","pushToken":"667b773e90871f014805f45f770c90d161b84b609d167039b2c388c7bacfdaa1","keys":{"proofOfPossession":{"x":"hFr-xcGSMHbWKq2_SUAOMkif1ARYAU-X_8ZGprOhxfw","y":"HVqAxDCiGcV7H0QAQas6CMbh2wyG-cPU_cwXv3kPqcI","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"2078892D-BC96-4C8C-A3FA-34045C002C4A"},"userVerification":{"x":"V0p-5JFpcen4Iep94ihs00Kjezw9sblfMSUW-cJxTRk","y":"wgJ9SFT3iaT6cqS08TBIBg_K-20r_4FMGFUlN2BXFJc","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"80D6AC7B-B640-4899-A32C-CA7B98BE0AE6"}},"capabilities":{"transactionTypes":["LOGIN","CIBA"]}}}},"summary":"Create app authenticator enrollment"},"components/examples/CreateWebAuthnExampleRequest":{"id":"components/examples/CreateWebAuthnExampleRequest","value":{"clientData":"eyJjaGFsbGVuZ...","attestation":"o2NmbXRoZmlk...","clientExtensions":"{\"credProps\":{\"rk\":true}}","transports":"[\"internal\"]"},"summary":"Create Passkey (FIDO2 WebAuthn) enrollment"},"components/examples/EnrollmentExampleEmail":{"id":"components/examples/EnrollmentExampleEmail","value":{"id":"eae3jiacDBMEjIC9V0g5","name":"Email","created":"2023-08-10T20:11:55.000Z","profile":{"email":"s***q@example.com"},"canReset":false,"canUnenroll":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments/eae3jiacDBMEjIC9V0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3ji50IyerHHpCa0g5/unenroll","hints":{"allow":["GET"]}}}},"summary":"Email enrollment"},"components/examples/EnrollmentExamplePassword":{"id":"components/examples/EnrollmentExamplePassword","value":{"id":"pasfs1tgsKqEha3JwZKq","name":"Okta password","created":"2023-05-01T14:24:54.000Z","lastChallenged":"2023-06-01T13:44:54.000Z","canReset":true,"canChangePassword":true,"canResetPassword":true,"canUnenroll":false,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym/enrollments/pasfs1tgsKqEha3JwZKq","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym","hints":{"allow":["GET"]}},"modify":{"href":"https://sampleorg.okta.com/idp/authenticators/aut7liEC2BWqGZ8tosym/modify","hints":{"allow":["GET"]}}}},"summary":"Password enrollment"},"components/examples/EnrollmentExampleSecurityKey":{"id":"components/examples/EnrollmentExampleSecurityKey","value":{"id":"fwf3jiaukymSFdBBS0g5","name":"YubiKey 5","created":"2023-05-01T14:24:54.000Z","lastChallenged":"2023-06-01T13:44:54.000Z","canReset":false,"canUnenroll":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym/enrollments/pasfs1tgsKqEha3JwZKq","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut7liEC2BWqGZ8tosym/unenroll","hints":{"allow":["GET"]}}}},"summary":"Security key enrollment"},"components/examples/ErrorAccessDenied":{"id":"components/examples/ErrorAccessDenied","value":{"errorCode":"E0000006","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"summary":"Access Denied"},"components/examples/ErrorNotAcceptable":{"id":"components/examples/ErrorNotAcceptable","value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"summary":"Not Acceptable"},"components/examples/ErrorResourceNotFound":{"id":"components/examples/ErrorResourceNotFound","value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"summary":"Resource Not Found"},"components/examples/ErrorTooManyRequests":{"id":"components/examples/ErrorTooManyRequests","value":{"errorCode":"E0000047","errorSummary":"You exceeded the maximum number of requests. Try again in a while.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"summary":"Too Many Requests"},"components/examples/GetPendingNotificationsJWTHeader":{"id":"components/examples/GetPendingNotificationsJWTHeader","value":[{"kid":"seD0hUMrcpFtlVVTmkDyJ0mGxlEygWEZ42ts9z4ih9M","typ":"okta-pushbind+jwt","alg":"RS256"}],"summary":"JWT Header"},"components/examples/GetPendingNotificationsJWTPayload":{"id":"components/examples/GetPendingNotificationsJWTPayload","value":[{"iss":"https://{{yourOktaDomain}}","aud":"okta.63c081db-1f13-5084-882f-e79e1e5e2da7","exp":1648339796,"iat":1648339496,"jti":"ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW","nonce":"LA_OIcYdr4R0GqMDJ08p","transactionId":"ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW","signals":["id","displayName","platform","manufacturer","model","osVersion","serialNumber","udid","sid","imei","meid","secureHardwarePresent","deviceAttestation"],"verificationUri":"https://{{yourOktaDomain}}/idp/myaccount/app-authenticators/challenge/ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW/verify","orgId":"00o54bswOJKhBhzy20w5","appInstanceName":"Okta Dashboard","method":"push","methodEnrollmentId":"opf6aeq9U2hoM8aqO0w5","authorizationServerId":"aus1k3lsbNOta5rds0g5","userMediation":"REQUIRED","userVerification":"PREFERRED","authenticatorEnrollmentId\"":"pfd7rzcmvlhmE0Y1w0g4","challengeContext":{"clientOS":"MAC_OS_X","clientLocation":"San Francisco, California, United States","transactionTime":"2022-03-27T00:04:56.861Z","transactionType":"LOGIN","bindingMessage":"Required if transactionType = CIBA"},"userId":"00u44bx5BuSpiLUMl0w5","ver":0}],"summary":"JWT Payload"},"components/examples/GetPendingNotificationsSuccessResponse":{"id":"components/examples/GetPendingNotificationsSuccessResponse","value":[{"payloadVersion":"IDXv1","challenge":"Your encoded challenge request JWT"}],"summary":"Success response"},"components/examples/ListAuthenticatorsExample":{"id":"components/examples/ListAuthenticatorsExample","value":[{"id":"aut3ji50IyerHHpCa0g5","key":"okta_email","name":"Email","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments","hints":{"allow":["GET"]}}}},{"id":"aut3ji4zFcHpwBlic0g5","key":"okta_password","name":"Password","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3ji4zFcHpwBlic0g5/enrollments","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5/enrollments","hints":{"allow":["GET"]}},"requirements":{"href":"https://sampleorg.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}},{"id":"aut3jiaiZukD4Ta0Z0g5","key":"webauthn","name":"Security Key or Biometric","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments","hints":{"allow":["GET"]}}}}],"summary":"List all authenticators"},"components/examples/ListAuthenticatorsExpandExample":{"id":"components/examples/ListAuthenticatorsExpandExample","value":[{"id":"aut3ji50IyerHHpCa0g5","key":"okta_email","name":"Email","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idpauthenticators/setup/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"eae3jiacDBMEjIC9V0g5","name":"Email","created":"2023-08-10T20:11:55.000Z","profile":{"email":"s***q@example.com"},"canUnenroll":true,"canReset":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments/eae3jiacDBMEjIC9V0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3ji50IyerHHpCa0g5/unenroll","hints":{"allow":["GET"]}}}}]}},{"id":"aut3ji4zFcHpwBlic0g5","key":"okta_password","name":"Password","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idpauthenticators/setup/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5/enrollments","hints":{"allow":["GET"]}},"requirements":{"href":"https://sampleorg.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"lae9bw3rvnO03wAbx0g4","name":"Password","created":"2023-08-10T20:11:55.000Z","canUnenroll":false,"canReset":true,"canChangePassword":true,"canResetPassword":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5/enrollments/lae9bw3rvnO03wAbx0g4","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}}}}],"requirements":{"description":"Password requirements: at least 8 characters, a lowercase letter, an uppercase letter, a number, no parts of your username. Your password cannot be any of your last 4 password(s).","complexity":{"minLength":8,"minLowerCase":1,"minUpperCase":1,"minNumber":1,"minSymbol":0,"excludeUsername":true,"excludeAttributes":[]},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}}}},{"id":"aut3jiaiZukD4Ta0Z0g5","key":"webauthn","name":"Security Key or Biometric","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"fwf3jiatpzkqerFkA0g5","name":"MacBook Touch ID","created":"2023-08-10T20:12:01.000Z","canUnenroll":true,"canReset":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiatpzkqerFkA0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3jiaiZukD4Ta0Z0g5/unenroll","hints":{"allow":["GET"]}}}},{"id":"fwf3jiaukymSFdBBS0g5","name":"YubiKey 5","created":"2023-08-10T20:12:03.000Z","canUnenroll":false,"canReset":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiaukymSFdBBS0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}}}}]}}],"summary":"List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter"},"components/examples/ListAuthenticatorsExpandOVBreakdownExample":{"id":"components/examples/ListAuthenticatorsExpandOVBreakdownExample","value":[{"id":"autf5jzpIaAbmXXQ30g4","key":"okta_verify_fastpass","name":"Okta Verify FastPass","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify FastPass","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}}}}]}},{"id":"autf5jyYtSkbEvFpv0g4","key":"okta_verify_push","name":"Okta Verify Push","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify Push","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}}}}]}},{"id":"autf5jxPRRciM4mXb0g4","key":"okta_verify_totp","name":"Okta Verify TOTP","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify TOTP","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}}}}]}},{"id":"okta_verify","key":"okta_verify","enrollable":true,"_links":{"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/okta_verify","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/okta_verify/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/okta_verify","hints":{"allow":["GET"]}}}}]}}],"summary":"List all authenticators with embedded enrollments including Okta Verify method-specific authenticators"},"components/examples/ListAuthenticatorsOVBreakdownExample":{"id":"components/examples/ListAuthenticatorsOVBreakdownExample","value":[{"id":"autf5jzpIaAbmXXQ30g4","key":"okta_verify_fastpass","name":"Okta Verify FastPass","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments","hints":{"allow":["GET"]}}}},{"id":"autf5jyYtSkbEvFpv0g4","key":"okta_verify_push","name":"Okta Verify Push","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments","hints":{"allow":["GET"]}}}},{"id":"autf5jxPRRciM4mXb0g4","key":"okta_verify_totp","name":"Okta Verify TOTP","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments","hints":{"allow":["GET"]}}}},{"id":"okta_verify","key":"okta_verify","enrollable":true,"_links":{"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/okta_verify","hints":{"allow":["GET"]}}}}],"summary":"List all authenticators including all Okta Verify method-specific authenticators"},"components/examples/ListEnrollmentsExample":{"id":"components/examples/ListEnrollmentsExample","value":[{"id":"fwf3jiatpzkqerFkA0g5","name":"MacBook Touch ID","created":"2023-08-10T20:12:01.000Z","canReset":false,"canUnenroll":true,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiatpzkqerFkA0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3jiaiZukD4Ta0Z0g5/unenroll","hints":{"allow":["GET"]}}}},{"id":"fwf3jiaukymSFdBBS0g5","name":"YubiKey 5","created":"2023-08-10T20:12:03.000Z","canReset":false,"canUnenroll":true,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiaukymSFdBBS0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3jiaiZukD4Ta0Z0g5/unenroll","hints":{"allow":["GET"]}}}}],"summary":"All security key and biometric enrollments"},"components/examples/RemoveAuthenticatorEnrollmentNicknameEx":{"id":"components/examples/RemoveAuthenticatorEnrollmentNicknameEx","value":{"nickname":null},"summary":"Remove authenticator enrollment nickname"},"components/examples/UnenrollAppAuthenticatorEnrollmentUserVerificationKey":{"id":"components/examples/UnenrollAppAuthenticatorEnrollmentUserVerificationKey","value":{"methods":{"push":{"keys":{"userVerification":null}}}},"summary":"Unenroll app authenticator enrollment user verification key"},"components/examples/UpdateAppAuthenticatorEnrollmentPushToken":{"id":"components/examples/UpdateAppAuthenticatorEnrollmentPushToken","value":{"methods":{"push":{"pushToken":"667b713e90871f014805f45f770c90d161b84b609d167039b2c388c7bacfdaa1"}}},"summary":"Update app authenticator enrollment push token"},"components/examples/UpdateAppAuthenticatorEnrollmentPushTokenAndUserVerificationKey":{"id":"components/examples/UpdateAppAuthenticatorEnrollmentPushTokenAndUserVerificationKey","value":{"methods":{"push":{"pushToken":"667b713e90871f014805f45f770c90d161b84b609d167039b2c388c7bacfdaa1","keys":{"userVerification":{"x":"V0p-5JFpcen4Iep94ihs00Kjezw9sblfMSUW-cJxTRk","y":"wgJ9SFT3iaT6cqS08TBIBg_K-20r_4FMGFUlN2BXFJc","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"80D6AC7B-B640-4899-A32C-CA7B98BE0AE6"}}}}},"summary":"Update app authenticator enrollment push token and enroll user verification key"},"components/examples/UpdateAppAuthenticatorEnrollmentTransactionType":{"id":"components/examples/UpdateAppAuthenticatorEnrollmentTransactionType","value":{"methods":{"push":{"capabilities":{"transactionTypes":["LOGIN","CIBA"]}}}},"summary":"Update app authenticator enrollment transaction type"},"components/examples/UpdateAppAuthenticatorEnrollmentUserVerificationKey":{"id":"components/examples/UpdateAppAuthenticatorEnrollmentUserVerificationKey","value":{"methods":{"push":{"keys":{"userVerification":{"x":"V0p-5JFpcen4Iep94ihs00Kjezw9sblfMSUW-cJxTRk","y":"wgJ9SFT3iaT6cqS08TBIBg_K-20r_4FMGFUlN2BXFJc","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"80D6AC7B-B640-4899-A32C-CA7B98BE0AE6"}}}}},"summary":"Enroll app authenticator enrollment user verification key"},"components/examples/UpdateAuthenticatorEnrollmentNicknameEx":{"id":"components/examples/UpdateAuthenticatorEnrollmentNicknameEx","value":{"nickname":"Bob's Phone"},"summary":"Update authenticator enrollment nickname"},"components/examples/VerifyPushNotificationChallengeJWTHeader":{"id":"components/examples/VerifyPushNotificationChallengeJWTHeader","value":{"typ":"okta-pushbind+jwt","kid":"b33b262d-b054-4519-833e-0893f53616ec","alg":"RS256"},"summary":"JWT Header"},"components/examples/VerifyPushNotificationChallengeJWTPayload":{"id":"components/examples/VerifyPushNotificationChallengeJWTPayload","value":{"iss":"pfd7rzcmvlhmE0Y1w0g4","sub":"00u12xkg3YOQqFyeC0g6","aud":"https://{{yourOktaDomain}}","jti":"9866e66d-e173-487a-878b-4059ffb15255","iat":1648687225,"exp":1648687525,"nbf":1648686925,"methodEnrollmentId":"opf13zf81eK3VfeHE0g6","tx":"ftxWtAah8d4Gv-P-ZcMdbSmELeRlRShWNR","nonce":"4OvrzlCotGBJIVCAzHb9","deviceSignals":{"id":"guo13zf7vXryjyUCU0g6","isHardwareProtectionEnabled":"false,","model":"Pixel 4","manufacturer":"Google","displayName":"Pixel 4","platform\"":"ANDROID","osVersion\"":"12:2022-03-05","clientInstanceId\"":"cli13zf7wfZ27xCRQ0g6","clientInstanceBundleId":"com.okta.devices.push.app","clientInstanceVersion":1,"secureHardwarePresent":true,"screenLockType":"BIOMETRIC","diskEncryptionType":"USER"},"keyType":"proofOfPossession","challengeResponseContext":{"userConsent":"APPROVED_CONSENT_PROMPT","transactionType":"LOGIN"}},"summary":"JWT Payload"},"components/examples/VerifyPushNotificationChallengeRequest":{"id":"components/examples/VerifyPushNotificationChallengeRequest","value":{"method":"push","challengeResponse":"Your encoded challenge response JWT"},"summary":"Push notification challenge request"},"paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment":{"value":{"authenticatorId":"aut12i8bdXk90NIfr0q5","device":{"secureHardwarePresent":true,"clientInstanceKey":{"x":"O0N1H3AIXj5p5cpQx5RUzowIRz1iPnheo7SbEC-CtFw","y":"Cea3KAFqsyxqPni2QJ6LjjqgRKgRHpsVzkNazd3m8To","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"DF47DEE2-D1B0-40B6-BEB7-09134CC4A19B"},"osVersion":"14.3","clientInstanceBundleId":"com.company.authenticatorApp","platform":"IOS","manufacturer":"APPLE","deviceAttestation":{},"clientInstanceVersion":"6.4.0","clientInstanceDeviceSdkVersion":"DeviceSDK 1.0.0","model":"iPhone","displayName":"My device name","udid":"4956095A-D99E-4A4E-A6DC-9E63E5978722"},"methods":{"push":{"apsEnvironment":"DEVELOPMENT","pushToken":"667b773e90871f014805f45f770c90d161b84b609d167039b2c388c7bacfdaa1","keys":{"proofOfPossession":{"x":"hFr-xcGSMHbWKq2_SUAOMkif1ARYAU-X_8ZGprOhxfw","y":"HVqAxDCiGcV7H0QAQas6CMbh2wyG-cPU_cwXv3kPqcI","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"2078892D-BC96-4C8C-A3FA-34045C002C4A"},"userVerification":{"x":"V0p-5JFpcen4Iep94ihs00Kjezw9sblfMSUW-cJxTRk","y":"wgJ9SFT3iaT6cqS08TBIBg_K-20r_4FMGFUlN2BXFJc","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"80D6AC7B-B640-4899-A32C-CA7B98BE0AE6"}},"capabilities":{"transactionTypes":["LOGIN","CIBA"]}}}},"key":"Create app authenticator enrollment","summary":"Create app authenticator enrollment","id":"paths/~1idp~1myaccount~1app-authenticators/post/requestBody/content/application~1json, okta-version=1.0.0/examples/Create app authenticator enrollment"},"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request":{"value":{"method":"push","challengeResponse":"Your encoded challenge response JWT"},"key":"Push notification challenge request","summary":"Push notification challenge request","id":"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/Push notification challenge request"},"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header":{"value":{"typ":"okta-pushbind+jwt","kid":"b33b262d-b054-4519-833e-0893f53616ec","alg":"RS256"},"key":"JWT Header","summary":"JWT Header","id":"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Header"},"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload":{"value":{"iss":"pfd7rzcmvlhmE0Y1w0g4","sub":"00u12xkg3YOQqFyeC0g6","aud":"https://{{yourOktaDomain}}","jti":"9866e66d-e173-487a-878b-4059ffb15255","iat":1648687225,"exp":1648687525,"nbf":1648686925,"methodEnrollmentId":"opf13zf81eK3VfeHE0g6","tx":"ftxWtAah8d4Gv-P-ZcMdbSmELeRlRShWNR","nonce":"4OvrzlCotGBJIVCAzHb9","deviceSignals":{"id":"guo13zf7vXryjyUCU0g6","isHardwareProtectionEnabled":"false,","model":"Pixel 4","manufacturer":"Google","displayName":"Pixel 4","platform\"":"ANDROID","osVersion\"":"12:2022-03-05","clientInstanceId\"":"cli13zf7wfZ27xCRQ0g6","clientInstanceBundleId":"com.okta.devices.push.app","clientInstanceVersion":1,"secureHardwarePresent":true,"screenLockType":"BIOMETRIC","diskEncryptionType":"USER"},"keyType":"proofOfPossession","challengeResponseContext":{"userConsent":"APPROVED_CONSENT_PROMPT","transactionType":"LOGIN"}},"key":"JWT Payload","summary":"JWT Payload","id":"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json;okta-version=1.0.0/examples/JWT Payload"},"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1app-authenticators~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token":{"value":{"methods":{"push":{"pushToken":"667b713e90871f014805f45f770c90d161b84b609d167039b2c388c7bacfdaa1"}}},"key":"Update app authenticator enrollment push token","summary":"Update app authenticator enrollment push token","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key":{"value":{"methods":{"push":{"keys":{"userVerification":{"x":"V0p-5JFpcen4Iep94ihs00Kjezw9sblfMSUW-cJxTRk","y":"wgJ9SFT3iaT6cqS08TBIBg_K-20r_4FMGFUlN2BXFJc","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"80D6AC7B-B640-4899-A32C-CA7B98BE0AE6"}}}}},"key":"Enroll app authenticator enrollment user verification key","summary":"Enroll app authenticator enrollment user verification key","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Enroll app authenticator enrollment user verification key"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key":{"value":{"methods":{"push":{"keys":{"userVerification":null}}}},"key":"Unenroll app authenticator enrollment user verification key","summary":"Unenroll app authenticator enrollment user verification key","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Unenroll app authenticator enrollment user verification key"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type":{"value":{"methods":{"push":{"capabilities":{"transactionTypes":["LOGIN","CIBA"]}}}},"key":"Update app authenticator enrollment transaction type","summary":"Update app authenticator enrollment transaction type","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment transaction type"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key":{"value":{"methods":{"push":{"pushToken":"667b713e90871f014805f45f770c90d161b84b609d167039b2c388c7bacfdaa1","keys":{"userVerification":{"x":"V0p-5JFpcen4Iep94ihs00Kjezw9sblfMSUW-cJxTRk","y":"wgJ9SFT3iaT6cqS08TBIBg_K-20r_4FMGFUlN2BXFJc","kty":"EC","okta:kpr":"HARDWARE","crv":"P-256","kid":"80D6AC7B-B640-4899-A32C-CA7B98BE0AE6"}}}}},"key":"Update app authenticator enrollment push token and enroll user verification key","summary":"Update app authenticator enrollment push token and enroll user verification key","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update app authenticator enrollment push token and enroll user verification key"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success response":{"value":[{"payloadVersion":"IDXv1","challenge":"Your encoded challenge request JWT"}],"key":"Success response","summary":"Success response","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success response"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Header":{"value":[{"kid":"seD0hUMrcpFtlVVTmkDyJ0mGxlEygWEZ42ts9z4ih9M","typ":"okta-pushbind+jwt","alg":"RS256"}],"key":"JWT Header","summary":"JWT Header","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Header"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Payload":{"value":[{"iss":"https://{{yourOktaDomain}}","aud":"okta.63c081db-1f13-5084-882f-e79e1e5e2da7","exp":1648339796,"iat":1648339496,"jti":"ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW","nonce":"LA_OIcYdr4R0GqMDJ08p","transactionId":"ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW","signals":["id","displayName","platform","manufacturer","model","osVersion","serialNumber","udid","sid","imei","meid","secureHardwarePresent","deviceAttestation"],"verificationUri":"https://{{yourOktaDomain}}/idp/myaccount/app-authenticators/challenge/ft-hqOpHM8yxcGvE0cN7UXWVodVyP0omKW/verify","orgId":"00o54bswOJKhBhzy20w5","appInstanceName":"Okta Dashboard","method":"push","methodEnrollmentId":"opf6aeq9U2hoM8aqO0w5","authorizationServerId":"aus1k3lsbNOta5rds0g5","userMediation":"REQUIRED","userVerification":"PREFERRED","authenticatorEnrollmentId\"":"pfd7rzcmvlhmE0Y1w0g4","challengeContext":{"clientOS":"MAC_OS_X","clientLocation":"San Francisco, California, United States","transactionTime":"2022-03-27T00:04:56.861Z","transactionType":"LOGIN","bindingMessage":"Required if transactionType = CIBA"},"userId":"00u44bx5BuSpiLUMl0w5","ver":0}],"key":"JWT Payload","summary":"JWT Payload","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/JWT Payload"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1app-authenticators~1{enrollmentId}~1push~1notifications/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators":{"value":[{"id":"aut3ji50IyerHHpCa0g5","key":"okta_email","name":"Email","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments","hints":{"allow":["GET"]}}}},{"id":"aut3ji4zFcHpwBlic0g5","key":"okta_password","name":"Password","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3ji4zFcHpwBlic0g5/enrollments","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5/enrollments","hints":{"allow":["GET"]}},"requirements":{"href":"https://sampleorg.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}},{"id":"aut3jiaiZukD4Ta0Z0g5","key":"webauthn","name":"Security Key or Biometric","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments","hints":{"allow":["GET"]}}}}],"key":"List all authenticators","summary":"List all authenticators","id":"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators"},"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter":{"value":[{"id":"aut3ji50IyerHHpCa0g5","key":"okta_email","name":"Email","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idpauthenticators/setup/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"eae3jiacDBMEjIC9V0g5","name":"Email","created":"2023-08-10T20:11:55.000Z","profile":{"email":"s***q@example.com"},"canUnenroll":true,"canReset":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments/eae3jiacDBMEjIC9V0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3ji50IyerHHpCa0g5/unenroll","hints":{"allow":["GET"]}}}}]}},{"id":"aut3ji4zFcHpwBlic0g5","key":"okta_password","name":"Password","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idpauthenticators/setup/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5/enrollments","hints":{"allow":["GET"]}},"requirements":{"href":"https://sampleorg.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"lae9bw3rvnO03wAbx0g4","name":"Password","created":"2023-08-10T20:11:55.000Z","canUnenroll":false,"canReset":true,"canChangePassword":true,"canResetPassword":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5/enrollments/lae9bw3rvnO03wAbx0g4","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji4zFcHpwBlic0g5","hints":{"allow":["GET"]}}}}],"requirements":{"description":"Password requirements: at least 8 characters, a lowercase letter, an uppercase letter, a number, no parts of your username. Your password cannot be any of your last 4 password(s).","complexity":{"minLength":8,"minLowerCase":1,"minUpperCase":1,"minNumber":1,"minSymbol":0,"excludeUsername":true,"excludeAttributes":[]},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}}}},{"id":"aut3jiaiZukD4Ta0Z0g5","key":"webauthn","name":"Security Key or Biometric","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"fwf3jiatpzkqerFkA0g5","name":"MacBook Touch ID","created":"2023-08-10T20:12:01.000Z","canUnenroll":true,"canReset":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiatpzkqerFkA0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3jiaiZukD4Ta0Z0g5/unenroll","hints":{"allow":["GET"]}}}},{"id":"fwf3jiaukymSFdBBS0g5","name":"YubiKey 5","created":"2023-08-10T20:12:03.000Z","canUnenroll":false,"canReset":false,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiaukymSFdBBS0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}}}}]}}],"key":"List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter","summary":"List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter","id":"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments using the `expand=enrollments,requirements` query parameter"},"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators including all Okta Verify method-specific authenticators":{"value":[{"id":"autf5jzpIaAbmXXQ30g4","key":"okta_verify_fastpass","name":"Okta Verify FastPass","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments","hints":{"allow":["GET"]}}}},{"id":"autf5jyYtSkbEvFpv0g4","key":"okta_verify_push","name":"Okta Verify Push","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments","hints":{"allow":["GET"]}}}},{"id":"autf5jxPRRciM4mXb0g4","key":"okta_verify_totp","name":"Okta Verify TOTP","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments","hints":{"allow":["GET"]}}}},{"id":"okta_verify","key":"okta_verify","enrollable":true,"_links":{"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/okta_verify","hints":{"allow":["GET"]}}}}],"key":"List all authenticators including all Okta Verify method-specific authenticators","summary":"List all authenticators including all Okta Verify method-specific authenticators","id":"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators including all Okta Verify method-specific authenticators"},"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments including Okta Verify method-specific authenticators":{"value":[{"id":"autf5jzpIaAbmXXQ30g4","key":"okta_verify_fastpass","name":"Okta Verify FastPass","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify FastPass","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}}}}]}},{"id":"autf5jyYtSkbEvFpv0g4","key":"okta_verify_push","name":"Okta Verify Push","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify Push","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}}}}]}},{"id":"autf5jxPRRciM4mXb0g4","key":"okta_verify_totp","name":"Okta Verify TOTP","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify TOTP","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}}}}]}},{"id":"okta_verify","key":"okta_verify","enrollable":true,"_links":{"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/okta_verify","hints":{"allow":["GET"]}}},"_embedded":{"enrollments":[{"id":"pfd1ohopjzzOlYOll0g5","name":"Okta Verify","created":"2026-06-11T23:14:51.000Z","lastChallenged":"2026-06-24T22:41:23.000Z","canReset":false,"canUnenroll":true,"profile":{"deviceName":"iPhone 17 Pro"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/okta_verify/enrollments/pfd1ohopjzzOlYOll0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/pfd1ohopjzzOlYOll0g5/unenroll","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/okta_verify","hints":{"allow":["GET"]}}}}]}}],"key":"List all authenticators with embedded enrollments including Okta Verify method-specific authenticators","summary":"List all authenticators with embedded enrollments including Okta Verify method-specific authenticators","id":"paths/~1idp~1myaccount~1authenticators/get/responses/200/content/application~1json/examples/List all authenticators with embedded enrollments including Okta Verify method-specific authenticators"},"paths/~1idp~1myaccount~1authenticators/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1idp~1myaccount~1authenticators/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1idp~1myaccount~1authenticators/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1authenticators/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1authenticators/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"You exceeded the maximum number of requests. Try again in a while.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1idp~1myaccount~1authenticators/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Password authenticator":{"value":{"id":"aut3jiaiZukD4Ta0Z0g5","key":"okta_password","name":"Okta password","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments","hints":{"allow":["GET"]}},"requirements":{"href":"https://sampleorg.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}},"key":"Password authenticator","summary":"Password authenticator","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Password authenticator"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Security key authenticator":{"value":{"id":"aut65i8bdXk90tyfr0q7","key":"webauthn","name":"Security Key or Biometric","enrollable":false,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut65i8bdXk90tyfr0q7","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut65i8bdXk90tyfr0q7/enrollments","hints":{"allow":["GET"]}}}},"key":"Security key authenticator","summary":"Security key authenticator","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Security key authenticator"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/External IdP authenticator":{"value":{"id":"autt5i9pIn7WMBUht0g4","key":"external_idp","name":"External IdP OIDC","enrollable":true,"logo":{"uri":"https://cdn.okta1.com/bc/globalFileStoreRecord?id=gfst5lrCKbaYgrZAX0g4"},"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autt5i9pIn7WMBUht0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autt5i9pIn7WMBUht0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autt5i9pIn7WMBUht0g4/enrollments","hints":{"allow":["GET"]}}}},"key":"External IdP authenticator","summary":"External IdP authenticator","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/External IdP authenticator"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify FastPass authenticator":{"value":{"id":"autf5jzpIaAbmXXQ30g4","key":"okta_verify_fastpass","name":"Okta Verify FastPass","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jzpIaAbmXXQ30g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jzpIaAbmXXQ30g4/enrollments","hints":{"allow":["GET"]}}}},"key":"Okta Verify FastPass authenticator","summary":"Okta Verify FastPass authenticator","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify FastPass authenticator"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify Push authenticator":{"value":{"id":"autf5jyYtSkbEvFpv0g4","key":"okta_verify_push","name":"Okta Verify Push","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jyYtSkbEvFpv0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jyYtSkbEvFpv0g4/enrollments","hints":{"allow":["GET"]}}}},"key":"Okta Verify Push authenticator","summary":"Okta Verify Push authenticator","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify Push authenticator"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify TOTP authenticator":{"value":{"id":"autf5jxPRRciM4mXb0g4","key":"okta_verify_totp","name":"Okta Verify TOTP","enrollable":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enroll":{"href":"https://sampleorg.okta.com/idp/authenticators/setup/autf5jxPRRciM4mXb0g4","hints":{"allow":["GET"]}},"enrollments":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/autf5jxPRRciM4mXb0g4/enrollments","hints":{"allow":["GET"]}}}},"key":"Okta Verify TOTP authenticator","summary":"Okta Verify TOTP authenticator","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/200/content/application~1json/examples/Okta Verify TOTP authenticator"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"You exceeded the maximum number of requests. Try again in a while.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/200/content/application~1json/examples/All security key and biometric enrollments":{"value":[{"id":"fwf3jiatpzkqerFkA0g5","name":"MacBook Touch ID","created":"2023-08-10T20:12:01.000Z","canReset":false,"canUnenroll":true,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiatpzkqerFkA0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3jiaiZukD4Ta0Z0g5/unenroll","hints":{"allow":["GET"]}}}},{"id":"fwf3jiaukymSFdBBS0g5","name":"YubiKey 5","created":"2023-08-10T20:12:03.000Z","canReset":false,"canUnenroll":true,"links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5/enrollments/fwf3jiaukymSFdBBS0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3jiaiZukD4Ta0Z0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3jiaiZukD4Ta0Z0g5/unenroll","hints":{"allow":["GET"]}}}}],"key":"All security key and biometric enrollments","summary":"All security key and biometric enrollments","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/200/content/application~1json/examples/All security key and biometric enrollments"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"You exceeded the maximum number of requests. Try again in a while.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Password enrollment":{"value":{"id":"pasfs1tgsKqEha3JwZKq","name":"Okta password","created":"2023-05-01T14:24:54.000Z","lastChallenged":"2023-06-01T13:44:54.000Z","canReset":true,"canChangePassword":true,"canResetPassword":true,"canUnenroll":false,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym/enrollments/pasfs1tgsKqEha3JwZKq","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym","hints":{"allow":["GET"]}},"modify":{"href":"https://sampleorg.okta.com/idp/authenticators/aut7liEC2BWqGZ8tosym/modify","hints":{"allow":["GET"]}}}},"key":"Password enrollment","summary":"Password enrollment","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Password enrollment"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Email enrollment":{"value":{"id":"eae3jiacDBMEjIC9V0g5","name":"Email","created":"2023-08-10T20:11:55.000Z","profile":{"email":"s***q@example.com"},"canReset":false,"canUnenroll":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5/enrollments/eae3jiacDBMEjIC9V0g5","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut3ji50IyerHHpCa0g5","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut3ji50IyerHHpCa0g5/unenroll","hints":{"allow":["GET"]}}}},"key":"Email enrollment","summary":"Email enrollment","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Email enrollment"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Security key enrollment":{"value":{"id":"fwf3jiaukymSFdBBS0g5","name":"YubiKey 5","created":"2023-05-01T14:24:54.000Z","lastChallenged":"2023-06-01T13:44:54.000Z","canReset":false,"canUnenroll":true,"_links":{"self":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym/enrollments/pasfs1tgsKqEha3JwZKq","hints":{"allow":["GET"]}},"authenticator":{"href":"https://sampleorg.okta.com/idp/myaccount/authenticators/aut7liEC2BWqGZ8tosym","hints":{"allow":["GET"]}},"unenroll":{"href":"https://sampleorg.okta.com/idp/authenticators/aut7liEC2BWqGZ8tosym/unenroll","hints":{"allow":["GET"]}}}},"key":"Security key enrollment","summary":"Security key enrollment","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/200/content/application~1json/examples/Security key enrollment"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"You exceeded the maximum number of requests. Try again in a while.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname":{"value":{"nickname":"Bob's Phone"},"key":"Update authenticator enrollment nickname","summary":"Update authenticator enrollment nickname","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Update authenticator enrollment nickname"},"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname":{"value":{"nickname":null},"key":"Remove authenticator enrollment nickname","summary":"Remove authenticator enrollment nickname","id":"paths/~1idp~1myaccount~1authenticators~1{authenticatorId}~1enrollments~1{enrollmentId}/patch/requestBody/content/application~1merge-patch+json;okta-version=1.0.0/examples/Remove authenticator enrollment nickname"},"paths/~1idp~1myaccount~1emails/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":[{"id":"69dca29c2d8dbb0dca14395ccdb92317","status":"VERIFIED","roles":["PRIMARY"],"profile":{"email":"saml.jackson@example.com"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/emails/69dca29c2d8dbb0dca14395ccdb92317","hints":{"allow":["GET"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/emails/69dca29c2d8dbb0dca14395ccdb92317/challenge","hints":{"allow":["POST"]}}}},{"id":"e2a84ed3cc538f75457596faa74a4532","status":"UNVERIFIED","roles":["PRIMARY"],"profile":{"email":"s.jackson@company.com"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532","hints":{"allow":["GET","DELETE"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge","hints":{"allow":["POST"]}},"verify":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.IDseIErVSEiFlLyAbzSp5Q/verify","hints":{"allow":["POST"]}},"poll":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.IDseIErVSEiFlLyAbzSp5Q","hints":{"allow":["GET"]}}}}],"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1emails/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1emails/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1emails/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1emails/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email":{"value":{"profile":{"email":"saml.jackson@example.com"},"sendEmail":true,"role":"PRIMARY","state":"JPcFLTwOq7UvoFtmRd3EnyQwsR0PbDSI"},"key":"New-Email","summary":"New-Email","id":"paths/~1idp~1myaccount~1emails/post/requestBody/content/application~1json/examples/New-Email"},"paths/~1idp~1myaccount~1emails/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"e2a84ed3cc538f75457596faa74a4532","status":"UNVERIFIED","roles":["PRIMARY"],"profile":{"email":"s.jackson@company.com"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532","hints":{"allow":["GET","DELETE"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge","hints":{"allow":["POST"]}},"verify":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.IDseIErVSEiFlLyAbzSp5Q/verify","hints":{"allow":["POST"]}},"poll":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.IDseIErVSEiFlLyAbzSp5Q","hints":{"allow":["GET"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1emails/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1emails/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-400":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: email","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid email address."}]},"key":"Invalid-Email-400","summary":"Invalid-Email-400","id":"paths/~1idp~1myaccount~1emails/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-400"},"paths/~1idp~1myaccount~1emails/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1emails/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1emails/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Secondary email is not enabled as an authenticator for your org."}]},"key":"Secondary-Email","summary":"Secondary-Email","id":"paths/~1idp~1myaccount~1emails/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"},"paths/~1idp~1myaccount~1emails/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1emails/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Email-Conflict-409":{"value":{"errorCode":"E0000157","errorSummary":"Another authenticator with key: email is already active.","errorLink":"E0000157","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"The email example@email.com is already registered to the current user profile."}]},"key":"Email-Conflict-409","summary":"Email-Conflict-409","id":"paths/~1idp~1myaccount~1emails/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Email-Conflict-409"},"paths/~1idp~1myaccount~1emails~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"69dca29c2d8dbb0dca14395ccdb92317","status":"VERIFIED","roles":["PRIMARY"],"profile":{"email":"saml.jackson@example.com"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/emails/69dca29c2d8dbb0dca14395ccdb92317","hints":{"allow":["GET"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/emails/69dca29c2d8dbb0dca14395ccdb92317/challenge","hints":{"allow":["POST"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1emails~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1emails~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1emails~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1emails~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Deletion-400":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: email","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Can't delete a verified email address."}]},"key":"Invalid-Email-Deletion-400","summary":"Invalid-Email-Deletion-400","id":"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Deletion-400"},"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404":{"value":{"errorCode":"E0000007","errorSummary":"Not found: Resource not found: 796bc844c1802c5ad5a65e1dbd26c30a (UserProfileEmail)","errorLink":"E0000007","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[]},"key":"Email-Resource-Not-Found-404","summary":"Email-Resource-Not-Found-404","id":"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"},"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example":{"value":{"state":"JPcFLTwOq7UvoFtmRd3EnyQwsR0PbDSI"},"key":"Challenge-Example","summary":"Challenge-Example","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/requestBody/content/application~1json/examples/Challenge-Example"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/201/content/application~1json;okta-version=1.0.0/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"]}}}},"key":"Challenge-Created-Response","summary":"Challenge-Created-Response","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Challenge-Created-Response"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Secondary email is not enabled as an authenticator for your org."}]},"key":"Secondary-Email","summary":"Secondary-Email","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404":{"value":{"errorCode":"E0000007","errorSummary":"Not found: Resource not found: 796bc844c1802c5ad5a65e1dbd26c30a (UserProfileEmail)","errorLink":"E0000007","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[]},"key":"Email-Resource-Not-Found-404","summary":"Email-Resource-Not-Found-404","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Resource-Not-Found-404"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/200/content/application~1json;okta-version=1.0.0/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"]}}}},"key":"Polling-Response-Example","summary":"Polling-Response-Example","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Polling-Response-Example"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404":{"value":{"errorCode":"E0000007","errorSummary":"Not found: Resource not found: myaccount.WJLzOhehQwSVUFLVTy2ywb (IdpMyAccountChallenge)","errorLink":"E0000007","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[]},"key":"Email-Challenge-Resource-Not-Found-404","summary":"Email-Challenge-Resource-Not-Found-404","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example":{"value":{"verificationCode":"456058"},"key":"OTP-Example","summary":"OTP-Example","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/requestBody/content/application~1json/examples/OTP-Example"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"IDP-MyAccount-not-enabled-401","summary":"IDP-MyAccount-not-enabled-401","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed","errorLink":"E0000004","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"User is not authorized."}]},"key":"Unauthorized-User-401","summary":"Unauthorized-User-401","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed","errorLink":"E0000004","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"The verification challenge failed due to an invalid code."}]},"key":"User-Failed-To-Answer-Challenge-401","summary":"User-Failed-To-Answer-Challenge-401","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Secondary email is not enabled as an authenticator for your org."}]},"key":"Secondary-Email","summary":"Secondary-Email","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404":{"value":{"errorCode":"E0000007","errorSummary":"Not found: Resource not found: myaccount.WJLzOhehQwSVUFLVTy2ywb (IdpMyAccountChallenge)","errorLink":"E0000007","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[]},"key":"Email-Challenge-Resource-Not-Found-404","summary":"Email-Challenge-Resource-Not-Found-404","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Email-Challenge-Resource-Not-Found-404"},"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1emails~1{id}~1challenge~1{challengeId}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1okta-applications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":[{"id":"okta.2b1959c8-bcc0-56eb-a589-cfcfb7422f26","name":"okta_enduser","displayName":"Okta Dashboard"},{"id":"okta.b8003760-1ca5-51b8-9404-85bb7ef9bc8c","name":"okta_account_settings","displayName":"Okta End user Settings"},{"id":"okta.ee074f99-1b5b-513e-8ea6-f8beeab8dbb9","name":"okta_browser_plugin","displayName":"Okta Browser Plugin"},{"id":"okta.b58d5b75-07d4-5f25-bf59-368a1261a405","name":"saasure","displayName":"Okta Admin Console"}],"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1okta-applications/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1okta-applications/get/responses/400/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1okta-applications/get/responses/400/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1okta-applications/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1okta-applications/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1organization/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"name":"TestOrg","url":"https://example.okta.com","helpLink":"https://example.okta.com/helpLink","supportEmail":"orgsupport@example.com","_links":{"self":{"href":"https://example.okta.com/idp/myaccount/organization","hints":{"allow":["GET"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1organization/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1organization/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1organization/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1organization/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1organization/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1password/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"00T196qTp3LIMZQ0L0g3","status":"ACTIVE","created":"2020-01-14T20:05:32.000Z","lastUpdated":"2020-01-14T20:05:32.000Z","_links":{"self":{"href":"https://example.okta.com/idp/myaccount/password","hints":{"allow":["GET","DELETE","PUT"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1password/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1password/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1password/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1password/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1password/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password":{"value":{"profile":{"password":"Abcd1234"}},"key":"New-Password","summary":"New-Password","id":"paths/~1idp~1myaccount~1password/post/requestBody/content/application~1json/examples/New-Password"},"paths/~1idp~1myaccount~1password/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"00T196qTp3LIMZQ0L0g3","status":"ACTIVE","created":"2020-01-14T20:05:32.000Z","lastUpdated":"2020-01-14T20:05:32.000Z","_links":{"self":{"href":"https://example.okta.com/idp/myaccount/password","hints":{"allow":["GET","DELETE","PUT"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1password/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Password","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"password: Password requirements were not met. Password requirements: at least 8 characters, a lowercase letter, an uppercase letter, a number, no parts of your username. Your password cannot be any of your last 4 password(s)."}]},"key":"Invalid-Password-400","summary":"Invalid-Password-400","id":"paths/~1idp~1myaccount~1password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"},"paths/~1idp~1myaccount~1password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Password-Conflict-409":{"value":{"errorCode":"E0000157","errorSummary":"This account already has a password set as an authenticator.","errorLink":"E0000157","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This account already has a password set as an authenticator."}]},"key":"Password-Conflict-409","summary":"Password-Conflict-409","id":"paths/~1idp~1myaccount~1password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Password-Conflict-409"},"paths/~1idp~1myaccount~1password/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1password/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password":{"value":{"profile":{"password":"Abcd1234"}},"key":"New-Password","summary":"New-Password","id":"paths/~1idp~1myaccount~1password/put/requestBody/content/application~1json/examples/New-Password"},"paths/~1idp~1myaccount~1password/put/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"00T196qTp3LIMZQ0L0g3","status":"ACTIVE","created":"2020-01-14T20:05:32.000Z","lastUpdated":"2020-01-14T20:05:32.000Z","_links":{"self":{"href":"https://example.okta.com/idp/myaccount/password","hints":{"allow":["GET","DELETE","PUT"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1password/put/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1password/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Password","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"password: Password requirements were not met. Password requirements: at least 8 characters, a lowercase letter, an uppercase letter, a number, no parts of your username. Your password cannot be any of your last 4 password(s)."}]},"key":"Invalid-Password-400","summary":"Invalid-Password-400","id":"paths/~1idp~1myaccount~1password/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"},"paths/~1idp~1myaccount~1password/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1password/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1password/put/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Secondary email is not enabled as an authenticator for your org."}]},"key":"Secondary-Email","summary":"Secondary-Email","id":"paths/~1idp~1myaccount~1password/put/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"},"paths/~1idp~1myaccount~1password/put/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1password/put/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1password/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1password/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1password/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Password-Resource-Not-Found-404":{"value":{"errorCode":"E0000007","errorSummary":"Not found: Resource not found: 796bc844c1802c5ad5a65e1dbd26c30a (UserProfilePassword)","errorLink":"E0000007","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[]},"key":"Password-Resource-Not-Found-404","summary":"Password-Resource-Not-Found-404","id":"paths/~1idp~1myaccount~1password/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Password-Resource-Not-Found-404"},"paths/~1idp~1myaccount~1password/delete/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1password/delete/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password":{"value":{"oldPassword":"Abcd1234","newPassword":"Abcd12345"},"key":"Change-Password","summary":"Change-Password","id":"paths/~1idp~1myaccount~1password~1change-password/post/requestBody/content/application~1json/examples/Change-Password"},"paths/~1idp~1myaccount~1password~1change-password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Password","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"password: Password requirements were not met. Password requirements: at least 8 characters, a lowercase letter, an uppercase letter, a number, no parts of your username. Your password cannot be any of your last 4 password(s)."}]},"key":"Invalid-Password-400","summary":"Invalid-Password-400","id":"paths/~1idp~1myaccount~1password~1change-password/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Password-400"},"paths/~1idp~1myaccount~1password~1change-password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1password~1change-password/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1password~1change-password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/MFA-Assurance-Not-Satisfied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"oaeU_LZTT_sRLq7wYflfRspDw","errorCauses":[]},"key":"MFA-Assurance-Not-Satisfied","summary":"MFA-Assurance-Not-Satisfied","id":"paths/~1idp~1myaccount~1password~1change-password/post/responses/403/content/application~1json;okta-version=1.0.0/examples/MFA-Assurance-Not-Satisfied"},"paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"description":"Password requirements: at least 8 characters, a lowercase letter, an uppercase letter, a number, no parts of your username. Your password cannot be any of your last 4 password(s).","complexity":{"minLength":8,"minLowerCase":1,"minUpperCase":1,"minNumber":1,"minSymbol":0,"excludeUsername":true,"excludeAttributes":[]},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/password/complexity-requirements","hints":{"allow":["GET"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1password~1complexity-requirements/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1phones/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":[{"id":"sms10ltpSdwXJCem80g4","status":"VERIFIED","profile":{"phoneNumber":"+13333333333"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/phones/sms10ltpSdwXJCem80g4","hints":{"allow":["GET","DELETE"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/phones/sms10ltpSdwXJCem80g4/challenge","hints":{"allow":["POST"]}}}},{"id":"sms18vrvVDDmi4Qlz0g4","status":"UNVERIFIED","profile":{"phoneNumber":"+12222222222"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/phones/sms18vrvVDDmi4Qlz0g4","hints":{"allow":["GET","DELETE"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/phones/sms18vrvVDDmi4Qlz0g4/challenge","hints":{"allow":["POST"]}},"verify":{"href":"https://example.okta.com/idp/myaccount/phones/sms18vrvVDDmi4Qlz0g4/verify","hints":{"allow":["POST"]}}}}],"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1phones/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1phones/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1phones/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1phones/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1phones/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge":{"value":{"profile":{"phoneNumber":"+1(444)444-4444"},"sendCode":true,"method":"SMS"},"key":"Okta-Sends-Challenge","summary":"Okta-Sends-Challenge","id":"paths/~1idp~1myaccount~1phones/post/requestBody/content/application~1json/examples/Okta-Sends-Challenge"},"paths/~1idp~1myaccount~1phones/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"sms18vtfKgzqDhNqP0g4","status":"UNVERIFIED","profile":{"phoneNumber":"+1(444)444-4444"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/phones/sms18vtfKgzqDhNqP0g4","hints":{"allow":["GET","DELETE"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/phones/sms18vtfKgzqDhNqP0g4/challenge","hints":{"allow":["POST"]}},"verify":{"href":"https://example.okta.com/idp/myaccount/phones/sms18vtfKgzqDhNqP0g4/verify","hints":{"allow":["POST"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1phones/post/responses/201/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Method","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid method some_invalid_method in the request."}]},"key":"Invalid-Method","summary":"Invalid-Method","id":"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method"},"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Not-A-Number":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Error type: NOT_A_NUMBER. The string supplied did not seem to be a phone number.","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid phone number."}]},"key":"Not-A-Number","summary":"Not-A-Number","id":"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Not-A-Number"},"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Country-Code":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Error type: INVALID_COUNTRY_CODE. Could not interpret numbers after plus-sign.","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid phone number."}]},"key":"Invalid-Country-Code","summary":"Invalid-Country-Code","id":"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Country-Code"},"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Too-Long":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Error type: TOO_LONG. The string supplied is too long to be a phone number.","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid phone number."}]},"key":"Too-Long","summary":"Too-Long","id":"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Too-Long"},"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Transaction","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid transaction."}]},"key":"Invalid-Transaction-Data-Type","summary":"Invalid-Transaction-Data-Type","id":"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"},"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Exceeded cardinality max","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This user account has reached the maximum number of enrolled phone numbers."}]},"key":"Cardinality-Max-Reached","summary":"Cardinality-Max-Reached","id":"paths/~1idp~1myaccount~1phones/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"},"paths/~1idp~1myaccount~1phones/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1phones/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Phone authenticator is not enabled for your org."}]},"key":"Phone-Authenticator-Disabled","summary":"Phone-Authenticator-Disabled","id":"paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"},"paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Method some_invalid_method is not enabled for your org."}]},"key":"Invalid-Authentication-Method-Type","summary":"Invalid-Authentication-Method-Type","id":"paths/~1idp~1myaccount~1phones/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"},"paths/~1idp~1myaccount~1phones/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1phones/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1phones/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Phone-Number-Exists-409":{"value":{"errorCode":"E0000157","errorSummary":"Another authenticator with key: +14161111111 is already active.","errorLink":"E0000157","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This phone number is already assigned to the current user account."}]},"key":"Phone-Number-Exists-409","summary":"Phone-Number-Exists-409","id":"paths/~1idp~1myaccount~1phones/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Phone-Number-Exists-409"},"paths/~1idp~1myaccount~1phones/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500":{"value":{"errorCode":"E0000138","errorSummary":"There was an internal error with call provider(s).","errorLink":"E0000138","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Failed to send the out of band OTP challenge. Set \"retry\" to \"true\" in the API request body and resubmit the API call to the endpoint."}]},"key":"Failed-To-Send-Out-Of-Band-Challenge-500","summary":"Failed-To-Send-Out-Of-Band-Challenge-500","id":"paths/~1idp~1myaccount~1phones/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"},"paths/~1idp~1myaccount~1phones~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"id":"sms10ltpSdwXJCem80g4","status":"VERIFIED","profile":{"phoneNumber":"+1(333)333-3333"},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/phones/sms10ltpSdwXJCem80g4","hints":{"allow":["GET","DELETE"]}},"challenge":{"href":"https://example.okta.com/idp/myaccount/phones/sms10ltpSdwXJCem80g4/challenge","hints":{"allow":["POST"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1phones~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1phones~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1phones~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1phones~1{id}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404":{"value":{"errorCode":"E0000008","errorSummary":"The requested path was not found","errorLink":"E0000008","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This operation couldn't be completed as requested due to an issue with the specified authenticator."}]},"key":"Invalid-Phone-Factor-Id-404","summary":"Invalid-Phone-Factor-Id-404","id":"paths/~1idp~1myaccount~1phones~1{id}/get/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"},"paths/~1idp~1myaccount~1phones~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1phones~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Phone authenticator is not enabled for your org."}]},"key":"Phone-Authenticator-Disabled","summary":"Phone-Authenticator-Disabled","id":"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"},"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404":{"value":{"errorCode":"E0000008","errorSummary":"The requested path was not found","errorLink":"E0000008","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This operation couldn't be completed as requested due to an issue with the specified authenticator."}]},"key":"Invalid-Phone-Factor-Id-404","summary":"Invalid-Phone-Factor-Id-404","id":"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"},"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1phones~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge":{"value":{"method":"SMS"},"key":"Send-SMS-Challenge","summary":"Send-SMS-Challenge","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-SMS-Challenge"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge":{"value":{"method":"CALL"},"key":"Send-Voice-Challenge","summary":"Send-Voice-Challenge","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/requestBody/content/application~1json/examples/Send-Voice-Challenge"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"_links":{"verify":{"href":"https://example.okta.com/idp/myaccount/emails/e2a84ed3cc538f75457596faa74a4532/challenge/myaccount.2wdtXPtmS0WpKq4bnjlYIw/verify","hints":{"allow":["POST"]}}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Method","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid method some_invalid_method in the request."}]},"key":"Invalid-Method","summary":"Invalid-Method","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Transaction","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid transaction."}]},"key":"Invalid-Transaction-Data-Type","summary":"Invalid-Transaction-Data-Type","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Phone authenticator is not enabled for your org."}]},"key":"Phone-Authenticator-Disabled","summary":"Phone-Authenticator-Disabled","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Method some_invalid_method is not enabled for your org."}]},"key":"Invalid-Authentication-Method-Type","summary":"Invalid-Authentication-Method-Type","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404":{"value":{"errorCode":"E0000008","errorSummary":"The requested path was not found","errorLink":"E0000008","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This operation couldn't be completed as requested due to an issue with the specified authenticator."}]},"key":"Invalid-Phone-Factor-Id-404","summary":"Invalid-Phone-Factor-Id-404","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500":{"value":{"errorCode":"E0000138","errorSummary":"There was an internal error with call provider(s).","errorLink":"E0000138","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Failed to send the out of band OTP challenge. Set \"retry\" to \"true\" in the API request body and resubmit the API call to the endpoint."}]},"key":"Failed-To-Send-Out-Of-Band-Challenge-500","summary":"Failed-To-Send-Out-Of-Band-Challenge-500","id":"paths/~1idp~1myaccount~1phones~1{id}~1challenge/post/responses/500/content/application~1json;okta-version=1.0.0/examples/Failed-To-Send-Out-Of-Band-Challenge-500"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge":{"value":{"verificationCode":"048284"},"key":"Verify-SMS-Challenge","summary":"Verify-SMS-Challenge","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/requestBody/content/application~1json/examples/Verify-SMS-Challenge"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Method","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid method some_invalid_method in the request."}]},"key":"Invalid-Method","summary":"Invalid-Method","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Method"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Transaction","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid transaction."}]},"key":"Invalid-Transaction-Data-Type","summary":"Invalid-Transaction-Data-Type","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-Data-Type"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: factorId and/or verificationCode","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This operation couldn't be completed as requested due to an issue with the specified authenticator."}]},"key":"Invalid-Phone-Factor-Id","summary":"Invalid-Phone-Factor-Id","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"IDP-MyAccount-not-enabled-401","summary":"IDP-MyAccount-not-enabled-401","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/IDP-MyAccount-not-enabled-401"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed","errorLink":"E0000004","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"User is not authorized."}]},"key":"Unauthorized-User-401","summary":"Unauthorized-User-401","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized-User-401"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed","errorLink":"E0000004","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"The verification challenge failed due to an invalid code."}]},"key":"User-Failed-To-Answer-Challenge-401","summary":"User-Failed-To-Answer-Challenge-401","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/401/content/application~1json;okta-version=1.0.0/examples/User-Failed-To-Answer-Challenge-401"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Phone authenticator is not enabled for your org."}]},"key":"Phone-Authenticator-Disabled","summary":"Phone-Authenticator-Disabled","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Phone-Authenticator-Disabled"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type":{"value":{"errorCode":"E0000038","errorSummary":"This operation is not allowed in the user's current status.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Method some_invalid_method is not enabled for your org."}]},"key":"Invalid-Authentication-Method-Type","summary":"Invalid-Authentication-Method-Type","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Invalid-Authentication-Method-Type"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404":{"value":{"errorCode":"E0000008","errorSummary":"The requested path was not found","errorLink":"E0000008","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This operation couldn't be completed as requested due to an issue with the specified authenticator."}]},"key":"Invalid-Phone-Factor-Id-404","summary":"Invalid-Phone-Factor-Id-404","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/404/content/application~1json;okta-version=1.0.0/examples/Invalid-Phone-Factor-Id-404"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-409":{"value":{"errorCode":"E0000157","errorSummary":"Another authenticator with key: transactionHandle is already active.","errorLink":"E0000157","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Failed to find a transaction. Either the challenge was answered or the factor id is invalid."}]},"key":"Invalid-Transaction-409","summary":"Invalid-Transaction-409","id":"paths/~1idp~1myaccount~1phones~1{id}~1verify/post/responses/409/content/application~1json;okta-version=1.0.0/examples/Invalid-Transaction-409"},"paths/~1idp~1myaccount~1profile/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"createdAt":"2020-01-14T20:05:32.000Z","modifiedAt":"2020-01-14T20:05:32.000Z","profile":{"customBoolean":false,"foo":"bar","login":"example@ex.ample.com","mobilePhone":"+1(555)555-5555","customInteger":42},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/profile"},"describedBy":{"href":"https://example.okta.com/idp/myaccount/profile/schema"}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1profile/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1profile/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1profile/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1profile/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1profile/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile":{"value":{"profile":{"customBoolean":true,"foo":"bar","login":"example@ex.ample.com","mobilePhone":"555-555-5555","customInteger":42}},"key":"Update-Profile","summary":"Update-Profile","id":"paths/~1idp~1myaccount~1profile/put/requestBody/content/application~1json/examples/Update-Profile"},"paths/~1idp~1myaccount~1profile/put/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"createdAt":"2020-01-14T20:05:32.000Z","modifiedAt":"2020-01-14T20:05:32.000Z","profile":{"customBoolean":true,"foo":"bar","login":"example@ex.ample.com","mobilePhone":"555-555-5555","customInteger":42},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/profile"},"describedBy":{"href":"https://example.okta.com/idp/myaccount/profile/schema"}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1profile/put/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Update-From-Profile":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: forUpdate","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"You cannot update email attributes using the profile endpoint. Use the emails endpoint to make any required changes."}]},"key":"Invalid-Email-Update-From-Profile","summary":"Invalid-Email-Update-From-Profile","id":"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Email-Update-From-Profile"},"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Value-Type-For-Property":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: forUpdate","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Invalid value data type for property 'some-property'"}]},"key":"Invalid-Value-Type-For-Property","summary":"Invalid-Value-Type-For-Property","id":"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Invalid-Value-Type-For-Property"},"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Missing-Property-Value-For-Self-Update":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: forUpdate","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Property 'some-property' needs a value passed.  To unset it, explicitly set it to null."}]},"key":"Missing-Property-Value-For-Self-Update","summary":"Missing-Property-Value-For-Self-Update","id":"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Missing-Property-Value-For-Self-Update"},"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Read-Only-Property-Changed-For-Self-Update":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: forUpdate","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Property 'some-property' is read only.  The value supplied must exactly match the existing value."}]},"key":"Read-Only-Property-Changed-For-Self-Update","summary":"Read-Only-Property-Changed-For-Self-Update","id":"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Read-Only-Property-Changed-For-Self-Update"},"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Corrupt-Profile-Prevents-Self-Update":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: forUpdate","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Your profile is corrupt in a way that requires administrative intervention.  Please contact support."}]},"key":"Corrupt-Profile-Prevents-Self-Update","summary":"Corrupt-Profile-Prevents-Self-Update","id":"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Corrupt-Profile-Prevents-Self-Update"},"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Concealed-Or-Unknown-Property-For-Self-Update":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: forUpdate","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"Property 'some-property' does not exist or is not accessible."}]},"key":"Concealed-Or-Unknown-Property-For-Self-Update","summary":"Concealed-Or-Unknown-Property-For-Self-Update","id":"paths/~1idp~1myaccount~1profile/put/responses/400/content/application~1json;okta-version=1.0.0/examples/Concealed-Or-Unknown-Property-For-Self-Update"},"paths/~1idp~1myaccount~1profile/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1profile/put/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1profile/put/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1profile/put/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1profile~1schema/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response":{"value":{"properties":{"customBoolean":{"permissions":{"SELF":"READ_WRITE"},"title":"customBoolean","type":"boolean"},"foo":{"permissions":{"SELF":"READ_ONLY"},"title":"foo","type":"string"},"login":{"maxLength":100,"minLength":5,"permissions":{"SELF":"READ_ONLY"},"required":true,"title":"Username","type":"string"},"mobilePhone":{"maxLength":100,"permissions":{"SELF":"READ_WRITE"},"title":"Mobile phone","type":"string"},"customInteger":{"permissions":{"SELF":"READ_WRITE"},"title":"customInteger","type":"integer"}},"_links":{"self":{"href":"https://example.okta.com/idp/myaccount/profile/schema"},"user":{"href":"https://example.okta.com/idp/myaccount/profile"}}},"key":"Success-Response","summary":"Success-Response","id":"paths/~1idp~1myaccount~1profile~1schema/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success-Response"},"paths/~1idp~1myaccount~1profile~1schema/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1profile~1schema/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1profile~1schema/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1profile~1schema/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1webauthn/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success":{"value":[{"id":"fwfn3c3rryqStmyp20g4","status":"ACTIVE","type":"security_key","key":"webauthn","name":"YubiKey 5 FIPS","credentialId":"5Ht9dBHqs8q2PbfWEuxqoDsnkO16KR_58GUju5MdSa__W_X7d5mQbkFSp273fxPX","created":"2025-04-22T17:24:27.000Z","lastUpdated":"2025-04-22T17:24:27.000Z","_links":{"self":{"href":"https://{yourOktaDomain}/idp/myaccount/webauthn/fwfn3c3rryqStmyp20g4","hints":{"allow":["GET","DELETE"]}}}}],"key":"Success","summary":"Success","id":"paths/~1idp~1myaccount~1webauthn/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"},"paths/~1idp~1myaccount~1webauthn/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1webauthn/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1webauthn/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1webauthn/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment":{"value":{"clientData":"eyJjaGFsbGVuZ...","attestation":"o2NmbXRoZmlk...","clientExtensions":"{\"credProps\":{\"rk\":true}}","transports":"[\"internal\"]"},"key":"Create Passkey (FIDO2 WebAuthn) enrollment","summary":"Create Passkey (FIDO2 WebAuthn) enrollment","id":"paths/~1idp~1myaccount~1webauthn/post/requestBody/content/application~1json/examples/Create Passkey (FIDO2 WebAuthn) enrollment"},"paths/~1idp~1myaccount~1webauthn/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success":{"value":{"id":"fwfn3c3rryqStmyp20g4","status":"ACTIVE","type":"security_key","key":"webauthn","name":"YubiKey 5 FIPS","credentialId":"5Ht9dBHqs8q2PbfWEuxqoDsnkO16KR_58GUju5MdSa__W_X7d5mQbkFSp273fxPX","created":"2025-04-22T17:24:27.000Z","lastUpdated":"2025-04-22T17:24:27.000Z","_links":{"self":{"href":"https://{yourOktaDomain}/idp/myaccount/webauthn/fwfn3c3rryqStmyp20g4","hints":{"allow":["GET","DELETE"]}}}},"key":"Success","summary":"Success","id":"paths/~1idp~1myaccount~1webauthn/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"},"paths/~1idp~1myaccount~1webauthn/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Exceeded cardinality max","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This user account has reached the maximum number of enrolled Passkey authenticators."}]},"key":"Cardinality-Max-Reached","summary":"Cardinality-Max-Reached","id":"paths/~1idp~1myaccount~1webauthn/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"},"paths/~1idp~1myaccount~1webauthn/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1webauthn/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1webauthn/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1idp~1myaccount~1webauthn/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1idp~1myaccount~1webauthn/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1webauthn/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Start WebAuthn enrollment response":{"value":{"options":{"rp":{"name":"example"},"user":{"displayName":"display name","name":"displayname@okta.com","id":"00ule5sHbd9kmYHtw0g4"},"pubKeyCredParams":[{"type":"public-key","alg":-7},{"type":"public-key","alg":-257}],"challenge":"vuSSUc8Nkd-8b2InKe3Y0SjEB4Nm6rdf","attestation":"direct","authenticatorSelection":{"userVerification":"discouraged","requireResidentKey":false,"residentKey":"preferred"},"u2fParams":{"appid":"https://{yourOktaDomain}"},"excludeCredentials":[{"type":"public-key","id":"5Ht9dBHqs8q2PbfWEuxqoDsnkO16KR_58GUju5MdSa__W_X7d5mQbkFSp273fxPX"}]},"expiresAt":"2025-04-30T18:04:33.000Z","_links":{"enroll":{"href":"https://{yourOktaDomain}/idp/myaccount/webauthn","hints":{"allow":["POST"]}}}},"key":"Start WebAuthn enrollment response","summary":"Start WebAuthn enrollment response","id":"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/200/content/application~1json;okta-version=1.0.0/examples/Start WebAuthn enrollment response"},"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Exceeded cardinality max","errorLink":"E0000001","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"This user account has reached the maximum number of enrolled Passkey authenticators."}]},"key":"Cardinality-Max-Reached","summary":"Cardinality-Max-Reached","id":"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/400/content/application~1json;okta-version=1.0.0/examples/Cardinality-Max-Reached"},"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email":{"value":{"errorCode":"E0000038","errorSummary":"WebAuthn enrollment is not allowed.","errorLink":"E0000038","errorId":"oaejUwz8U5FQ_SyggQwz1kC3w","errorCauses":[{"errorSummary":"WebAuthn is not enabled for the org."}]},"key":"Secondary-Email","summary":"Secondary-Email","id":"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/403/content/application~1json;okta-version=1.0.0/examples/Secondary-Email"},"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1webauthn~1registration/post/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success":{"value":{"id":"fwfn3c3rryqStmyp20g4","status":"ACTIVE","type":"security_key","key":"webauthn","name":"YubiKey 5 FIPS","credentialId":"5Ht9dBHqs8q2PbfWEuxqoDsnkO16KR_58GUju5MdSa__W_X7d5mQbkFSp273fxPX","created":"2025-04-22T17:24:27.000Z","lastUpdated":"2025-04-22T17:24:27.000Z","_links":{"self":{"href":"https://{yourOktaDomain}/idp/myaccount/webauthn/fwfn3c3rryqStmyp20g4","hints":{"allow":["GET","DELETE"]}}}},"key":"Success","summary":"Success","id":"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/200/content/application~1json;okta-version=1.0.0/examples/Success"},"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1webauthn~1{id}/get/responses/406/content/application~1json/examples/Not Acceptable"},"paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized":{"value":{"errorCode":"E0000015","errorSummary":"You do not have permission to access the feature you are requesting","errorLink":"E0000015","errorId":"oaeStOuPPxDRUm3PJhf-tL7bQ","errorCauses":[]},"key":"Unauthorized","summary":"Unauthorized","id":"paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/401/content/application~1json;okta-version=1.0.0/examples/Unauthorized"},"paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable":{"value":{"errorCode":"E0000149","errorSummary":"The HTTP request is not acceptable","errorLink":"E0000149","errorId":"sampleXIg7wJviL5zXm5wRCWB","errorCauses":[]},"key":"Not Acceptable","summary":"Not Acceptable","id":"paths/~1idp~1myaccount~1webauthn~1{id}/delete/responses/406/content/application~1json/examples/Not Acceptable"}},"securitySchemeStore":{"oauth2":{"id":"oauth2","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the access_token as the value of the Authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {access_token}"},"children":[]}]}]}],"flows":{"authorizationCode":{"authorizationUrl":"/oauth2/v1/authorize","tokenUrl":"/oauth2/v1/token","scopes":{"okta.myAccount.appAuthenticator.maintenance.manage":"Write access to non-sensitive attributes of user app authenticator enrollments","okta.myAccount.appAuthenticator.maintenance.read":"Read access to non-sensitive attributes of user app authenticator enrollments","okta.myAccount.appAuthenticator.manage":"Write access to user app authenticator enrollments","okta.myAccount.authenticators.manage":"Write access to user authenticator enrollments","okta.myAccount.authenticators.read":"Read access to user authenticator configurations and enrollments","okta.myAccount.email.manage":"Write access to user emails","okta.myAccount.email.read":"Read access to user emails","okta.myAccount.oktaApplications.read":"Read access to the Okta apps list","okta.myAccount.organization.read":"Read access to org details","okta.myAccount.password.manage":"Write access to user password","okta.myAccount.password.read":"Read access to user password metadata","okta.myAccount.phone.manage":"Write access to user phones","okta.myAccount.phone.read":"Read access to user phones","okta.myAccount.profile.manage":"Write access to user profile and schema","okta.myAccount.profile.read":"Read access to user profile and schema","okta.myAccount.sessions.manage":"Write access to user sessions","okta.myAccount.webauthn.manage":"Write access to user Passkey (FIDO2 WebAuthn) enrollments","okta.myAccount.webauthn.read":"Read access to user Passkey (FIDO2 WebAuthn) enrollments"}}}}},"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain of your organization. This can be an official Okta domain (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oktapreview.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or one of your configured custom domains."},"children":[]}]}]}]}}}]},"options":{"hideInfoMetadata":true,"hideDownloadButtons":true,"hideReplay":true,"layout":"three-panel","sanitize":true,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"C#"},{"lang":"Java"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"Payload"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/docs/api/_bundle/openapi/okta-myaccount/myaccount.json?download"},{"url":"/docs/api/_bundle/openapi/okta-myaccount/myaccount.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"MyAccount Management","description":"APIs for managing a user's own emails, phones, profile, and app authenticators.\n> **Note:** The MyAccount API doesn't support [delegated authentication](https://help.okta.com/okta_help.htm?id=ext_Security_Authentication)."}},"baseSlug":"/openapi/okta-myaccount/myaccount","routesMapping":{}}