Clerk docs

Members

Used to interact with the members of an organization. The current user must be an administrator to access them.

Create Organization Membership

Create a new organization membership.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

query Parameters
user_id
string or null

The user id to be added as a member.

role
string or null
Request Body schema: application/x-www-form-urlencoded
required
email_address
string or null

The email address the invitation will be sent to.

role
string or null

The role that will be assigned to the user after joining. This can be one of the predefined roles (admin, basic_member) or a custom role defined.

Responses
200

Returns the response for Client wrapped OrganizationMembership object.

400

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/memberships
Request samples
application/x-www-form-urlencoded
email_address=string&role=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get All Organization Members

Retrieve all members of an organization.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

query Parameters
limit
number
offset
number
Responses
200

Returns the response for Client wrapped array of OrganizationMembership objects.

401

Request was not successful

403

Request was not successful

422

Request was not successful

get/v1/organizations/{organization_id}/memberships
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update Organization Membership

Update the attributes of a organization membership for a specific user. The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

user_id
required
string

The member ID.

Request Body schema: application/x-www-form-urlencoded
required
role
string

The role that new role that will be assigned to the member. This can be one of the predefined roles (admin, basic_member) or a custom role defined.

Responses
200

Returns the response for Client wrapped OrganizationMembership object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

patch/v1/organizations/{organization_id}/memberships/{user_id}
Request samples
application/x-www-form-urlencoded
role=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Remove Organization Member

Remove a member from an organization.

The current user must have permissions to manage the members of the organization.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

user_id
required
string

The member ID.

Responses
200

Returns the response for Client wrapped OrganizationMembership object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

delete/v1/organizations/{organization_id}/memberships/{user_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to Domains