Project

The Project object contains the information and configuration of a project, such as the name, description, and enabled authentication methods.

Each Stack app corresponds to a project. You can obtain its Project object by calling stackApp.getProject() or stackApp.useProject() .

Table of Contents


The unique ID of the project as a string.

Type Definition
declare const id: string;

The display name of the project as a string.

Type Definition
declare const displayName: string;

The configuration settings for the project.

Properties

signUpEnabledboolean

Indicates if sign-up is enabled for the project.

credentialEnabledboolean

Specifies if credential-based authentication is enabled for the project.

magicLinkEnabledboolean

States whether magic link authentication is enabled for the project.

clientTeamCreationEnabledboolean

Determines if client-side team creation is permitted within the project.

clientUserDeletionEnabledboolean

Indicates if client-side user deletion is enabled for the project.

Type Definition
declare const config: {
  signUpEnabled: boolean;
  credentialEnabled: boolean;
  magicLinkEnabled: boolean;
  clientTeamCreationEnabled: boolean;
  clientUserDeletionEnabled: boolean;
};

Stack Auth AI

Documentation assistant

Experimental: AI responses may not always be accurate—please verify important details.

For the most accurate information, please join our Discord or email us.

How can I help?

Ask me about Stack Auth while you browse the docs.