SignIn

The SignIn object contains the state of the current sign-in that the user has initiated.

Name

Description

status

string | null

The current status of the sign-in.

It can take the following values:

  • needs_identifier: First step of every sign-in flow is to provide the identifier of the user that will be signed in.

  • needs_factor_one: Need to verify the first factor selected for the provided identifier.

  • needs_factor_two: Need to verify the second factor selected for the provided identifier.

  • complete: The sign-in is complete and the user is signed in.

  • abandoned: The sign-in has been inactive for a long period of time, thus it's considered as abandoned and need to start over.

supportedIdentifiers

string[]

Array of all the identifiers that are allowed for this sign-up.

Examples of this could be email_address, phone_number or username.

supportedExternalAccounts

string[]

Array of all the external accounts that could be used in this sign-in, e.g. oauth_google, oauth_facebook, etc.

supportedFirstFactors

SignInFactor[]

Array of the first factors that are supported in the current sign-in.

Each factor contains information about the verification strategy that can

be used, e.g. email_code for email addresses, phone_code for phone numbers, etc., as well as the identifier that the factor refers to.

supportedSecondFactors

SignInFactor[] | null

Array of the second factors that are supported in the current sign-in, similar to supportedFirstFactors.

Please note that this property is populated only when the first factor is verified.

firstFactorVerification

VerificationResource

The state of the verification process for the selected first factor.

Please note that this property contains an empty verification object initially, since there is no first factor selected. You need to call the prepareFirstFactor in order to start the verification process.

secondFactorVerification

VerificationResource

The state of the verification process for the selected second factor.

Similar to firstFactorVerification, this property contains an empty verification object initially, since there is no second factor selected. You need to call the prepareSecondFactor in order to start the verification process.

identifier

string | null

The selected identifier for the current sign-in.

userData

UserData | null

An object containing information about the user of the current sign-in.

This property is populated only once an identifier is given to the sign-in.

createdSessionId

string | null

The identifier of the session that was created upon completion of the current sign-in.

The value of this property is null if the sign-in is not complete.

‚Äč