Skip to main content

Interface.IKeybanAuth

Authentication service contract.

See

IKeybanApi

Properties

PropertyTypeDescription
getUser() => Promise<null | KeybanUser>Retrieves the authenticated user profile, or null.
isAuthenticated() => Promise<boolean>Checks whether the current user is authenticated.
sendOtp(args: AuthSendOtpArgs) => Promise<void>Sends an OTP to email or phone.
signIn(args: AuthSignInArgs) => Promise<KeybanUser>Signs in a user using password or OTP.
signOut() => Promise<void>Signs out the current user.
signUp(args: AuthSignUpArgs) => Promise<KeybanUser>Registers a new user account.