OrganizationMembership
The relationship between users and organizations.
Overview
The OrganizationMembership object is the model around an organization membership entity.
Attributes
| Name | Type | Description |
|---|---|---|
| id | string | A unique identifier for this organization membership. |
| publicMetadata | object | Custom metadata that are visible to the frontend. |
| role | MembershipRole | The role of the current user in the organization. |
| publicUserData | PublicUserData | Public information about the user that this membership belongs to. |
| organization | OrganizationResource | The organization object the membership belongs to. |
| createdAt | Date | Date of the time the membership was created. |
| updatedAt | Date | Date of the last time the membership was updated. |
Methods
destroy()
destroy()=>Promise<void>Deletes the membership from the organization it belongs to.
update(params)
updateMember(params: UpdateOrganizationMembershipParams) =>Promise<OrganizationMembershipResource>Updates the membership. For now only role can be changed.
Parameters
| Name | Type | Description |
|---|---|---|
| role | MembershipRole | The role of the new member. |
Returns
| Name | Type | Description |
|---|---|---|
| <OrganizationInvitationResource> | Promise | This method returns a |