Confirm New Email For External IdP Auth Flow

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Confirms the user's new email address using an external IdP authentication flow. After authenticating with the user's external identity provider, the user's email address will be updated to the new one. Additionally, an email will be sent to the user's new email address confirming that the change operation completed successfully.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
change-email-workflow:executeApplicationThe subject can perform this operation on requests associated with the application to which the subject belongs.
Body Params

Confirm New Email For External IdP Auth Request JSON object

Object representing a request to confirm a user's new email as part of an external IdP authentication flow.

string
required
length ≥ 1

The external IdP auth code that will be used to authorize the request.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json