OrganizationMembership
The OrganizationMembership object is the model around an organization membership entity and describes the relationship between users and organizations.
Properties
- Name
id- Type
string- Description
The unique identifier for this organization membership.
- Name
publicMetadata- Type
- OrganizationMembershipPublicMetadata
- Description
Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
- Name
role- Type
string- Description
The role of the current user in the organization.
- Name
publicUserData- Type
- PublicUserData
- Description
Public information about the user that this membership belongs to.
- Name
organization- Type
- Organization
- Description
The Organization object the membership belongs to.
- Name
createdAt- Type
Date- Description
The date when the membership was created.
- Name
updatedAt- Type
Date- Description
The date when the membership was last updated.
function destroy(): Promise<OrganizationMembership>update()
Updates the member's role.
function update(updateParams: UpdateOrganizationMembershipParams): Promise<OrganizationMembership>- Name
role- Type
string- Description
The role of the new member.
Feedback
Last updated on