Get a role

Retrieves a single role by its unique identifier. Optionally includes the number of users assigned to the role.

Use this endpoint to read one role by its ID. The response returns the role's name, description, permission set, and the structure types it is scoped to.

Read the role before you update it. Updating a role is a full replacement, so you need the current permission set and type scope to send back.

Requirements

πŸ“˜

There is no endpoint to list existing roles. Track the ID returned by Create a role.

Include the user count

Set include_user_count to true to return user_count, the number of users assigned to this role. The count is omitted by default.

Path Params
string
required

UUID of the role

Query Params
boolean

Whether to include user count for this role

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json