Sign in
Users > Roles

Get user role

Retrieve the details of an existing user role.

get/v1/users/roles/{id}

Path parameters

idstring required

Response

idstring required

Role ID.

namestring required

Role name.

descriptionstring nullable required

Role description.

is_defaultboolean required

Whether this is the default role assigned to new users.

Example response

{
  "id": "rol_DKL4Xcb5VSa8CQ",
  "name": "Admin"
}

Changes