Replace Clerk role set

Replace a role set with another role set in a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/role-sets/{role_set_id}/replace

https://api.vee3.io/v1/clerk/role-sets/{role_set_id}/replace

10 tokens

Replace a role set with another role set in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.replace_role_set

Parameters4 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

role_set_idstringRequired

Clerk role set id or key to retrieve, update, or modify.

dest_role_set_keystringRequired

Key of the destination role set to migrate members to.

reassignment_mappingsobjectOptional

Optional map of source role keys to destination role keys.

Response3 fields

role_set_migrationobject

2 fields

Clerk role set migration payload.

idstring

Role set migration id.

statusstring

Migration status (for example pending or completed).

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/role-sets/{role_set_id}/replace"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "role_set_id": "orgroleset_2abc123",
    "dest_role_set_key": "default"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Role set migration started.

role_set_migration.json

{
  "role_set_migration": {
    "id": "rsm_2abc123",
    "status": "pending"
  }
}