Skip to main content
impersonation.authenticate wraps the Authenticate Impersonation Token API endpoint.

If this method succeeds and the is not required to complete , the Member will be logged in, granted an active session, and the .

If this method succeeds and MFA is required, the intermediate session token will be stored in the browser as a cookie.

Parameters

string
required
The Member Impersonation token to authenticate. Expires in 5 minutes by default.

Response

string
The unique ID of the Member.
object
The new Stytch Session.
object
The Member object of the signed-in Member.
object
The Organization object of the Organization the Member has signed into.
string
The JWT for the new Stytch Session.
If the project is configured to use HttpOnly cookies, this field will always be an empty string.
string
The secret token for the new Stytch Session.
If the project is configured to use HttpOnly cookies, this field will always be an empty string.
object
If Protected Auth is enabled and returned fingerprinting results, this field will contain information about the member’s device attributes.
boolean
Indicates whether the Member is fully authenticated. If false, the Member needs to complete an MFA step to log in to the Organization.
string
The intermediate_session_token that should be passed into a secondary authentication endpoint, such as OTP authenticate, in order to receive a member session. The intermediate_session_token can also be used with discovery endpoints to join a different organization or create a new organization.If the member is fully authenticated, this field will be an empty string.
If the project is configured to use HttpOnly cookies, this field will always be an empty string.
object | null
The types of primary authentication required.
object | null
The types of secondary authentication required to join the Organization.
object
If Protected Auth is enabled and returned fingerprinting results, this field will contain information about the member’s device attributes.
string
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
number
The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.