Ugrás a fő tartalomhoz

Overview

Authentication module for managing user authentication and authorization. The module automatically stores tokens in local storage when available and manages authorization headers for API requests.

Features

This module provides comprehensive authentication functionality including:
  • Email/password login and registration
  • Token management
  • User profile access and updates
  • Password reset flows
  • OTP verification
  • User invitations

Authentication Modes

The auth module is only available in user authentication mode (base44.auth).

Methods

me()

me(): Promise<User>
Gets the current authenticated user’s information.

Returns

User Promise resolving to the user’s profile data.
string
kötelező
Unique user identifier.
string
kötelező
When the user was created.
string
kötelező
When the user was last updated.
string
kötelező
User’s email address.
string | null
kötelező
User’s full name.
boolean | null
kötelező
Whether the user is disabled.
boolean
kötelező
Whether the user’s email has been verified.
string
kötelező
The app ID this user belongs to.
boolean
kötelező
Whether this is a service account.
string
kötelező
User’s role in the app. Roles are configured in the app settings and determine the user’s permissions and access levels.
any
Additional custom fields defined in the user schema. Any custom properties added to the user schema in the app will be available here with their configured types and values.

Example


updateMe()

updateMe(data): Promise<User>
Updates the current authenticated user’s information. You can update any custom fields defined in your User entity schema. Field-level security write rules on custom User fields also apply to this method. If data includes a field the user isn’t allowed to write, the call throws a permission error and no fields are updated. Updating role requires editor access on the app.
These fields can’t be changed with this method: id, email, full_name, created_date, updated_date, created_by, and collaborator_role.

Parameters

Record<string, any>
kötelező
Object containing the fields to update.

Returns

User Promise resolving to the updated user data.
string
kötelező
Unique user identifier.
string
kötelező
When the user was created.
string
kötelező
When the user was last updated.
string
kötelező
User’s email address.
string | null
kötelező
User’s full name.
boolean | null
kötelező
Whether the user is disabled.
boolean
kötelező
Whether the user’s email has been verified.
string
kötelező
The app ID this user belongs to.
boolean
kötelező
Whether this is a service account.
string
kötelező
User’s role in the app. Roles are configured in the app settings and determine the user’s permissions and access levels.
any
Additional custom fields defined in the user schema. Any custom properties added to the user schema in the app will be available here with their configured types and values.

Example


redirectToLogin()

redirectToLogin(nextUrl): void
Redirects the user to the app’s login page. Redirects with a callback URL to return to after successful authentication. Requires a browser environment and can’t be used in the backend.

Parameters

string
kötelező
URL to redirect to after successful login.

Returns

void

Throws

When not in a browser environment.

Examples


loginWithProvider()

loginWithProvider(provider, fromUrl?): void
Redirects the user to a third-party authentication provider’s login page. Initiates an OAuth login flow with one of the built-in providers. Requires a browser environment and can’t be used in the backend. Supported providers:
  • 'google': Google OAuth. Enabled by default.
  • 'microsoft': Microsoft OAuth. Enable Microsoft in your app’s authentication settings before specifying this provider.
  • 'facebook': Facebook Login. Enable Facebook in your app’s authentication settings before using.
  • 'apple': Sign in with Apple. Enable Apple in your app’s authentication settings before using this provider.
  • 'sso': Enterprise SSO. Set up an SSO provider in your app’s authentication settings before using this provider.

Parameters

string
kötelező
The authentication provider to use: 'google', 'microsoft', 'facebook', 'apple', or 'sso'.
string
URL to redirect to after successful authentication. Defaults to '/'.

Returns

void

Examples


logout()

logout(redirectUrl?): void
Logs out the current user. Removes the authentication token from local storage and Axios headers, then optionally redirects to a URL or reloads the page. Requires a browser environment and can’t be used in the backend.

Parameters

string
Optional URL to redirect to after logout. Reloads the page if not provided.

Returns

void

Examples


setToken()

setToken(token, saveToStorage?): void
Sets the authentication token. Updates the authorization header for API requests and optionally saves the token to local storage for persistence. Saving to local storage requires a browser environment and is automatically skipped in backend environments.

Parameters

string
kötelező
JWT authentication token.
boolean
Whether to save the token to local storage. Defaults to true.

Returns

void

Examples


loginViaEmailPassword()

loginViaEmailPassword(
email,
password,
turnstileToken?
): Promise<LoginResponse>
Logs in a registered user using email and password. Authenticates a user with email and password credentials. The user must already have a registered account. For new users, use register() first to create an account. On successful login, automatically sets the token for subsequent requests.

Parameters

string
kötelező
User’s email address.
string
kötelező
User’s password.
string
Has no effect. Base44 doesn’t verify Turnstile tokens for app users.

Returns

LoginResponse Promise resolving to login response with access token and user data.
string
kötelező
JWT access token for authentication.
User
kötelező
User information.
string
kötelező
Unique user identifier.
string
kötelező
When the user was created.
string
kötelező
When the user was last updated.
string
kötelező
User’s email address.
string | null
kötelező
User’s full name.
boolean | null
kötelező
Whether the user is disabled.
boolean
kötelező
Whether the user’s email has been verified.
string
kötelező
The app ID this user belongs to.
boolean
kötelező
Whether this is a service account.
string
kötelező
User’s role in the app. Roles are configured in the app settings and determine the user’s permissions and access levels.

Throws

Error if the email and password combination is invalid or the user is not registered.

Examples


isAuthenticated()

isAuthenticated(): Promise<boolean>
Checks if the current user is authenticated.

Returns

Promise<boolean> Promise resolving to true if authenticated, false otherwise.

Example


hasToken()

hasToken(): boolean
Checks whether an access token is currently set on the client. Reports only that a token is present, not that it’s valid: an expired or revoked token still returns true. Use it to skip requests that can’t succeed without a session, such as me() for an anonymous visitor, and use isAuthenticated() to confirm a session with the server. The token is the one passed to createClient() or set with setToken(), and logout() clears it. A session held only in an HTTP-only cookie isn’t visible to the client and returns false.

Returns

boolean

Example


inviteUser()

inviteUser(userEmail, role): Promise<any>
Invites a user to the app. Sends an invitation email to a potential user with a specific role. Roles are configured in the app settings and determine the user’s permissions and access levels.

Parameters

string
kötelező
Email address of the user to invite.
string
kötelező
Role to assign to the invited user. Must match a role defined in the app. For example, 'admin' or 'user'.

Returns

Promise<any> Promise that resolves when the invitation is sent successfully. Throws an error if the invitation fails.

Example


register()

register(params): Promise<any>
Registers a new user account. Creates a new user account with email and password. Registration sends an OTP code to the user’s email. Pass that code to verifyOtp() to complete verification, then log the user in with loginViaEmailPassword().

Parameters

RegisterParams
kötelező
Registration details including email, password, and optional fields.
string
kötelező
User’s email address.
string
kötelező
User’s password.
string | null
Has no effect. Base44 doesn’t verify Turnstile tokens for app users.
string | null
Optional referral code from an existing user.

Returns

Promise<any> Promise resolving to the registration response.

Example


verifyOtp()

verifyOtp(params): Promise<any>
Verifies an OTP (one-time password) code. Confirms that the user owns the email address by checking the code sent to their inbox during register(). After a successful call, log the user in with loginViaEmailPassword(). If the code has expired or the user didn’t receive it, send a fresh one with resendOtp().

Parameters

VerifyOtpParams
kötelező
The email being verified and the OTP code the user entered.
string
kötelező
User’s email address.
string
kötelező
One-time password code received by email.

Returns

Promise<any> Promise resolving to the verification response, which includes an access token for the now-verified user.

Throws

Error if the OTP code is invalid or expired.

Examples


resendOtp()

resendOtp(email): Promise<any>
Resends an OTP code to the user’s email address. Call this when the user didn’t receive the original code sent by register(), or when the previous code has expired. The new code replaces the previous one. Pass it to verifyOtp() to complete verification.

Parameters

string
kötelező
Email address to send the new OTP to.

Returns

Promise<any> Promise resolving once the new OTP has been sent, with a confirmation message and the new code’s expiration window.

Throws

Error if the email is invalid or the request fails.

Example


resetPasswordRequest()

resetPasswordRequest(email): Promise<any>
Requests a password reset. Sends a password reset email to the specified email address.

Parameters

string
kötelező
Email address for the account to reset.

Returns

Promise<any> Promise resolving when the password reset email is sent successfully.

Throws

Error if the email is invalid or the request fails.

Example


resetPassword()

resetPassword(params): Promise<any>
Resets password using a reset token. Completes the password reset flow by setting a new password using the token received by email.

Parameters

ResetPasswordParams
kötelező
Object containing the reset token and new password.
string
kötelező
Reset token received by email.
string
kötelező
New password to set.

Returns

Promise<any> Promise resolving when the password is reset successfully.

Throws

Error if the reset token is invalid, expired, or the request fails.

Example


changePassword()

changePassword(params): Promise<any>
Changes the user’s password. Updates the password for an authenticated user by verifying the current password and setting a new one.

Parameters

ChangePasswordParams
kötelező
Object containing user ID, current password, and new password.
string
kötelező
User ID.
string
kötelező
Current password for verification.
string
kötelező
New password to set.

Returns

Promise<any> Promise resolving when the password is changed successfully.

Throws

Error if the current password is incorrect or the request fails.

Example