The Backend Organization object
The Backend Organization object is similar to the Organization object as it holds information about an organization, as well as methods for managing it. However, the Backend Organization object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.
Properties
- Name
id- Type
string- Description
A unique identifier for the organization.
- Name
name- Type
string- Description
The name of the organization.
- Name
slug- Type
string- Description
The organization slug. If supplied, it must be unique for the instance.
- Name
createdBy- Type
string- Description
The ID of the user who created the organization.
- Name
createdAt- Type
number- Description
Date when the organization was first created.
- Name
updatedAt- Type
number- Description
Date of the last time the organization was updated.
- Name
imageUrl- Type
string- Description
Holds the organization's logo. Compatible with Clerk's Image Optimization.
- Name
hasImage- Type
boolean- Description
Whether the organization has an image.
- Name
publicMetadata- Type
{[string]: any}- Description
Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
- Name
privateMetadata- Type
{[string]: any}- Description
Metadata that can be read and set only from the Backend API.
- Name
maxAllowedMemberships- Type
number- Description
The maximum number of memberships allowed in the organization.
- Name
adminDeleteEnabled- Type
boolean- Description
Whether the organization allows admins to delete users.
- Name
membersCount?- Type
number- Description
The number of members in the organization.
Feedback
Last updated on