Skip to content

SignUpSecurityKeyHookResult


isError required Ref<boolean>

@returns

true if an error occurred

@depreacted

use !isSuccess or !!error instead


error required Ref<null | AuthErrorPayload>

Provides details about the error


isLoading required Ref<boolean>

@returns

true when the action is executing, false when it finished its execution.


isSuccess required Ref<boolean>

Returns true if the action is successful.


user required Ref<null | User>

User information


accessToken required Ref<null | string>

Access token (JWT)


refreshToken required Ref<null | string>

Access token (JWT)


needsEmailVerification required Ref<boolean>

@returns

true if an email is required to complete the action, and that a verification email has been sent to complete the action.


signUpEmailSecurityKey required SignUpSecurityKeyHandler

Used for a new user to sign up with a security key. Returns a promise with the current context