Role Sets

Retrieve a role set

Changed on

Retrieves an existing role set by its key or ID.

get/role_sets/{role_set_key_or_id}

Request

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

Path parameters

role_set_key_or_idstring required

The key or ID of the role set

Response

Success

object'role_set' required
idstring required

The unique identifier of the role set

namestring required

The name of the role set

keystring required

A unique key for the role set (e.g., "role_set:default")

descriptionstring nullable required

Optional description of the role set

type'initial' | 'custom' required

The type of the role set ("initial" or "custom")

created_atinteger required

Unix timestamp of role set creation

updated_atinteger required

Unix timestamp of last role set update

Changes