Skip to main content

deleteOrganizationMembership()

Removes a user from the given Organization.

Returns the deleted OrganizationMembership.

function deleteOrganizationMembership(params: DeleteOrganizationMembershipParams): Promise<OrganizationMembership>

DeleteOrganizationMembershipParams

  • Name
    organizationId
    Type
    string
    Description

    The ID of the Organization to remove the user from.

  • Name
    userId
    Type
    string
    Description

    The ID of the user to remove from the Organization.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const organizationId = 'org_123'
const userId = 'user_123'

const response = await clerkClient.organizations.deleteOrganizationMembership({
  organizationId,
  userId,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/organizations/{organization_id}/memberships/{user_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub