Site Home
API Reference
LoginTry for Free

Authorize External IdP User for Change Email

get
https://{application_vanity_domain}/api/v1/change-email/external-idp/authorize-user
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

↪️

Redirect Required

Your application will need to redirect to this endpoint instead of making a direct API call.

🏢

Tenant Vanity Domain Required

When calling this API you need to use the vanity domain of the tenant that the user belongs to.

Returns a 302 redirect response to an external identity provider's user authorization flow as part of a change email workflow. This API should be used to authenticate users who belong to an external identity provider before updating the user's email to the new one.

Query Params
string
required
length ≥ 1

The name of the external identity provider that should authorize the user.

string
length ≥ 1

The email auth code that was sent in the invitation email. This value should only be provided for invitations of type EMAIL.

Responses

Updated 29 days ago

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

Updated 29 days ago