Parameters


interpreter required Interpreter<AuthContext, any, { type: “SESSION_UPDATE”, data: { session: NhostSession } } | { type: “TRY_TOKEN”, token: string } | { type: “SIGNIN_ANONYMOUS” } | { type: “SIGNIN_PAT”, pat: string } | { type: “SIGNIN_SECURITY_KEY_EMAIL”, email: string } | { type: “SIGNIN_PASSWORD”, email: string, password: string } | { type: “PASSWORDLESS_EMAIL”, email: string, options: PasswordlessOptions } | { type: “PASSWORDLESS_SMS”, phoneNumber: string, options: PasswordlessOptions } | { type: “PASSWORDLESS_SMS_OTP”, phoneNumber: string, otp: string } | { type: “SIGNUP_EMAIL_PASSWORD”, email: string, password: string, options: SignUpOptions } | { type: “SIGNUP_SECURITY_KEY”, email: string, options: SignUpSecurityKeyOptions } | { type: “SIGNOUT”, all: boolean } | { type: “SIGNIN_MFA_TOTP”, ticket: string, otp: string } | { type: “SIGNED_IN” } | { type: “SIGNED_OUT” } | { type: “TOKEN_CHANGED” } | { type: “AWAIT_EMAIL_VERIFICATION” }, { value: any, context: AuthContext }, ResolveTypegenMeta<Typegen0, { type: “SESSION_UPDATE”, data: { session: NhostSession } } | { type: “TRY_TOKEN”, token: string } | { type: “SIGNIN_ANONYMOUS” } | { type: “SIGNIN_PAT”, pat: string } | { type: “SIGNIN_SECURITY_KEY_EMAIL”, email: string } | { type: “SIGNIN_PASSWORD”, email: string, password: string } | { type: “PASSWORDLESS_EMAIL”, email: string, options: PasswordlessOptions } | { type: “PASSWORDLESS_SMS”, phoneNumber: string, options: PasswordlessOptions } | { type: “PASSWORDLESS_SMS_OTP”, phoneNumber: string, otp: string } | { type: “SIGNUP_EMAIL_PASSWORD”, email: string, password: string, options: SignUpOptions } | { type: “SIGNUP_SECURITY_KEY”, email: string, options: SignUpSecurityKeyOptions } | { type: “SIGNOUT”, all: boolean } | { type: “SIGNIN_MFA_TOTP”, ticket: string, otp: string } | { type: “SIGNED_IN” } | { type: “SIGNED_OUT” } | { type: “TOKEN_CHANGED” } | { type: “AWAIT_EMAIL_VERIFICATION” }, BaseActionObject, AuthServices>>


email required string


options optional SignUpSecurityKeyOptions

PropertyTypeRequiredNotes
options.nicknamestringOptional nickname for the security key
options.redirectTostringRedirection path in the client application that will be used in the link in the verification email. For instance, if you want to redirect to https://myapp.com/success, the redirectTo value is '/success'.
options.metadataRecord<string, unknown>Custom additional user information stored in the metadata column. Can be any JSON object.
options.displayNamestringDisplay name of the user. If not provided, it will use the display name given by the social provider (Oauth) used on registration, or the email address otherwise.
options.defaultRolestringDefault role of the user. Must be part of the default allowed roles defined in Hasura Auth.
options.allowedRolesArray<string>Allowed roles of the user. Must be a subset of the default allowed roles defined in Hasura Auth.
options.localestringLocale of the user, in two digits