Interface LoginOptions

Options for constructing the login flow.

See

startLogin

Hierarchy

  • LoginOptions

Properties

appId? authMethod? callbackUrl? client? code? mode? userClass?

Properties

Optional appId

appId?: string

appId inferred from settings

Optional authMethod

authMethod?: AuthMethod

Pre-select a login method. Defaults to asking the user.

Optional callbackUrl

callbackUrl?: string | URL

Override the callbackUrl. Needs to be whitelisted in the dashboard.

Optional client

client?: "Web"

Client (must be 'Web')

Optional code

code?: string

Signup-code for user classes that require a code to sign up. If not set, the user may be prompted to enter a signup code.

Optional mode

mode?: "login" | "register"

Pre-select a mode. Defaults to automatic detection.

Optional userClass

userClass?: string

Which user class to add when logging in.

Settings

Member Visibility

Theme

Generated using TypeDoc