Role Sets

Replace a role set

Changed on

Replaces a role set with another role set. This is functionally equivalent to deleting the role set but allows for atomic replacement with migration support. Organizations using this role set will be migrated to the destination role set.

post/role_sets/{role_set_key_or_id}/replace

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/role_sets/{role_set_key_or_id}/replace
  • Auth: HTTP bearer

Path parameters

role_set_key_or_idstring required

The key or ID of the role set to replace

Request body

dest_role_set_keystring required

The key of the destination role set

reassignment_mappingsReassignmentMappings

Mappings from source role keys to destination role keys for role reassignment

Response

Deleted Object

objectstring required
idstring
slugstring
deletedboolean required
external_idstring

Changes