Class RolesApi

Adds a permission to a role.

Adds a user to a role.

Clone an existing role

Create a new role for your organization.

Restricted permissions, such as Dashboards Read and Monitors Read, are added to every new role by default, even if they are omitted from the request. To exclude them, set default_permissions_opt_out to true.

Disables a role.

Get a role in the organization specified by the role’s role_id.

Returns a list of all permissions, including name, description, and ID.

Returns a list of all permissions for a single role.

List all role templates

Gets all users of a role.

Returns all roles, including their names and their unique identifiers.

Removes a permission from a role.

Removes a user from a role.

Edit a role. Can only be used with application keys belonging to administrators.

Restricted permissions, such as Dashboards Read and Monitors Read, remain on the role by default, even if they are omitted from the request. To exclude them, set default_permissions_opt_out to true.

Omitting the permissions relationship from the request leaves the role's existing permissions unchanged. Sending "permissions": {"data": []} removes all permissions except restricted default permissions, which remain unless default_permissions_opt_out is true. Some restricted permissions can only be excluded after Minimal Access Roles is enabled for the organization.