The Backend OrganizationMembership object
The Backend OrganizationMembership object is similar to the OrganizationMembership object as it is the model around an organization membership entity and describes the relationship between users and organizations. However, the Backend OrganizationMembership 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 membership.
- Name
role- Type
OrganizationMembershipRole- Description
The role of the user.
- 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
createdAt- Type
number- Description
Date when the membership was first created.
- Name
updatedAt- Type
number- Description
Date of the last time the membership was updated.
- Name
organization- Type
Organization- Description
The organization that the user is a member of.
- Name
publicUserData?- Type
OrganizationMembershipPublicUserData- Description
Public information about the user that this membership belongs to.
- Name
identifier- Type
string- Description
The identifier of the user.
- Name
firstName- Type
string- Description
The first name of the user.
- Name
lastName- Type
string- Description
The last name of the user.
- Name
imageUrl- Type
string- Description
Holds the default avatar or user's uploaded profile image. Compatible with Clerk's Image Optimization.
- Name
hasImage- Type
boolean- Description
Whether the user has a profile picture.
- Name
userId- Type
string- Description
The ID of the user that this public data belongs to.
Feedback
Last updated on