SignIn

The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.

There are two important steps in the sign in flow.

1. Users must complete a first factor verification. This can be something like providing a password, an email link, a one-time code (OTP), a web3 wallet public address or providing proof of their identity through an external social account (SSO/OAuth).
2. After that, users might need to go through a second verification process. This is the second factor (2FA).

The SignIn object's properties can be split into logical groups, with each group providing information on different aspects of the sign in flow. These groups can be:

• Information about the current sign in status in general and which authentication identifiers, authentication methods and verifications are supported.
• Information about the user and the provided authentication identifier value (email address, phone number or username).Information about each verification, either the first factor (logging in) or the second factor (2FA).

Properties

Methods

create()

Use this method to kick-off the sign in flow. It creates a SignIn object and stores the sign-in lifecycle state.

Depending on the use-case and the params you pass to the create method, it can either complete the sign-in process in one go, or simply collect part of the necessary data for completing authentication at a later stage.

function create(params: SignInCreateParams): Promise<SignIn>;

SignInCreateParams

create() returns

resetPassword()

Resets a user's password.

function resetPassword(params: ResetPasswordParams): Promise<SignIn>;

ResetPasswordParams

resetPassword() returns

createEmailLinkFlow()

Sets up a sign in with email link flow. Calling createemailLinkFlow() will return two functions. The first function is async and starts the email link flow, preparing a email link verification. It sends the email link email and starts polling for verification results. The signature is startEmailLinkFlow({ redirectUrl: string, emailAddressId: string }) => Promise<SignInResource>.

The second function can be used to stop polling at any time, allowing for full control of the flow and cleanup. The signature is cancelEmailLinkFlow() => void.

function createEmailLinkFlow(): {
  startEmailLinkFlow: (params: SignInStartEmailLinkFlowParams) => Promise<SignIn>,
  cancelEmailLinkFlow: () => void
}

createEmailLinkFlow() returns

createEmailLinkFlow returns an object with two functions:

SignInStartEmailLinkFlowParams

Additional methods

In addition to the methods listed above, the SignIn class also has the following methods:

First factor

• prepareFirstFactor()
• attemptFirstFactor()

Second factor

• prepareSecondFactor()
• attemptSecondFactor()

Authenticate with

• authenticateWithRedirect()
• authenticateWithMetamask()
• authenticateWithWeb3()

Last updated on April 19, 2024