Project

This is a reference for the Project type in the Next.js SDK.

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

type Project = {
  id: string;
  displayName: string;
  config: {
    signUpEnabled: boolean;
    credentialEnabled: boolean;
    magicLinkEnabled: boolean;
    clientTeamCreationEnabled: boolean;
    clientUserDeletionEnabled: boolean;
  };
};

project.id

The unique ID of the project as a string.

declare const id: string;

project.displayName

The display name of the project as a string.

declare const displayName: string;

project.config

The configuration settings for the project.

• signUpEnabled: Indicates if sign-up is enabled for the project.
• credentialEnabled: Specifies if credential-based authentication is enabled for the project.
• magicLinkEnabled: States whether magic link authentication is enabled for the project.
• clientTeamCreationEnabled: Determines if client-side team creation is permitted within the project.
• clientUserDeletionEnabled: Indicates if client-side user deletion is enabled for the project.

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