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().

Table of Contents

1type Project = {
2  id: string;  //$stack-link-to:#projectid
3  displayName: string;  //$stack-link-to:#projectdisplayname
4  config: { ... };  //$stack-link-to:#projectconfig
5};

project.id

The unique ID of the project as a string.

Type Definition

1declare const id: string;

project.displayName

The display name of the project as a string.

Type Definition

1declare const displayName: string;

project.config

The configuration settings for the project.

signUpEnabled
boolean

Indicates if sign-up is enabled for the project.

credentialEnabled
boolean

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

magicLinkEnabled
boolean

States whether magic link authentication is enabled for the project.

clientTeamCreationEnabled
boolean

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

clientUserDeletionEnabled
boolean

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

Type Definition

1declare const config: {
2  signUpEnabled: boolean;
3  credentialEnabled: boolean;
4  magicLinkEnabled: boolean;
5  clientTeamCreationEnabled: boolean;
6  clientUserDeletionEnabled: boolean;
7};
Built with