Organization Members
These are all methods on the Organization class that allow you to manage the members of an organization.
getMemberships()
Retrieve the members of the currently active organization.
function getMemberships(params?: GetMembersParams): Promise<ClerkPaginatedResponse<OrganizationMembership>>;
GetMembersParams
| Name | Type | Description |
|---|---|---|
initialPage? | number | A number that can be used to skip the first n-1 pages. For example, if initialPage is set to 10, it is will skip the first 9 pages and will fetch the 10th page. |
pageSize? | number | A number that indicates the maximum number of results that should be returned for a specific page. |
role? | array | The roles of memberships that will be included in the response. For example, ['org:admin', 'org:member'] |
GetMembershipsParams was updated to GetMembersParams in September, 2023. The limit and offset parameters are now deprecated.
getMemberships() returns
| Type | Description |
|---|---|
Promise<ClerkPaginatedResponse<OrganizationMembership>> | A Promise which resolves with a ClerkPaginatedResponse of OrganizationMembership objects. |
addMember()
Adds a user as a member to an organization. A user can only be added to an organization if they are not already members of it and if they already exist in the same instance as the organization.
Please note that only administrators can add members to an organization.
function addMember(params: AddMemberParams): Promise<OrganizationMembership>;
AddMemberParams
| Name | Type | Description |
|---|---|---|
userId | string | The ID of the user that will be added as a member to the organization. |
role | string | The role that the user will have in the organization. |
addMember() returns
| Type | Description |
|---|---|
Promise<OrganizationMembership> | A Promise which resolves with theOrganizationMembership objects. |
updateMember()
Updates a member based on the userId. Currently, only a user's role can be updated.
function updateMember(params: UpdateMembershipParams): Promise<OrganizationMembership>;
UpdateMembershipParams
| Name | Type | Description |
|---|---|---|
userId | string | The user identifier. |
role | string | The role of the new member. |
updateMember() returns
| Type | Description |
|---|---|
Promise<OrganizationMembership> | A Promise which resolves with the updated OrganizationMembership objects. |
removeMember()
Removes a member from the organization based on the userId.
function removeMember(userId: string): Promise<OrganizationMembership>;
removeMember() params
| Name | Type | Description |
|---|---|---|
userId | string | The user identifier. |
removeMember() returns
| Type | Description |
|---|---|
Promise<OrganizationMembership> | A Promise which resolves with the removed OrganizationMembership object. |