app

Overview

App module for reading an app’s public settings. Use it to read the app’s visibility and determine whether the current visitor can access the app. If the app requires login, use redirectToLogin() from the auth module to send the visitor to the login page. Learn more about app visibility.

Authentication modes

You can use this module with a client in any authentication mode. The client sends its token, if it has one, with the request.

Methods

getPublicSettings()

getPublicSettings(): Promise<AppPublicSettingsResponse>

Retrieves the app’s public settings. Rejects with a Base44Error that has a status of 403 when the visitor can’t access the app. Check data.extra_data.reason to find the cause:

auth_required: The visitor must sign in.
user_not_registered: The visitor is signed in but doesn’t have access.

Returns

AppPublicSettingsResponse The app’s public settings.

Properties

string

requis

The app’s ID.

AppPublicSettings

requis

The app’s visibility. For supported values, see AppPublicSettings.

Example

try {
  const { public_settings } = await base44.app.getPublicSettings();
  console.log('App visibility:', public_settings);
} catch (error) {
  if (error.status === 403 && error.data?.extra_data?.reason === 'auth_required') {
    base44.auth.redirectToLogin('<URL to return to after login>');
  }
}

Type Definitions

AppPublicSettings

AppPublicSettings = "private_with_login" | "public_with_login" | "public_without_login" | "workspace_with_login" | string

The app’s visibility. You can set and manage the app’s visibility in the app’s dashboard or with the Base44 CLI visibility command. The following table shows the supported values and the visibility each one represents:

Value	Visibility
`private_with_login`	Private: Only invited users
`workspace_with_login`	Workspace: Users in your Base44 workspace
`public_with_login`	Public (login required): Visitors must log in
`public_without_login`	Public (no login): Anyone

If your workspace enforces SSO for apps, apps set to public_without_login also require sign-in.

Get Started

SDK Reference

Overview

Authentication modes

Methods

getPublicSettings()

Returns

Example

Type Definitions

AppPublicSettings

​Overview

​Authentication modes

​Methods

​getPublicSettings()

​Returns

​Example

​Type Definitions

​AppPublicSettings

Overview

Authentication modes

Methods

getPublicSettings()

Returns

Example

Type Definitions

AppPublicSettings