Skip to main content
Skip to main content

AuthenticationResponse

The details of the authentication response.

successbooleanRequired
Whether the authentication was successful.
authUserany
The authenticated user's details.
errorstring
If an error occurs during the authentication process, whether within the Auth Module or a third-party provider, the error message is set in this field.
locationstring
The URL to redirect to for further authentication action with a third-party provider. This takes precedence before the success field. So, after checking that authentication is successful, you should check whether this field is defined and, if so, redirect to the specified location.
successRedirectUrlstring
Some authentication providers support redirecting to a specified URL on success. In those cases, the URL to redirect to is set in this field. So, if success is true, there's no location set, and this field is set, you can redirect to this URL.
Was this section helpful?