Skip to main content

createOrganizationMembership()

Creates a membership to an Organization for a user directly (circumventing the need for an invitation).

Returns the newly created OrganizationMembership object.

function createOrganizationMembership(params: CreateOrganizationMembershipParams): Promise<OrganizationMembership>

CreateOrganizationMembershipParams

  • Name
    organizationId
    Type
    string
    Description

    The ID of the Organization the user is being added to.

  • Name
    role
    Type
    OrganizationCustomRoleKey
    Description

    The Role to assign to the user.

  • Name
    userId
    Type
    string
    Description

    The ID of the user to be added to 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.

In the following example, an OrganizationMembership is created for a user with the Role org:member.

const organizationId = 'org_123'
const userId = 'user_123'
const role = 'org:member'

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

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub