Class RolesManager

Associate permissions with a role.

Associate permissions with a role

Throws

Assign users to a role. Assign users to a role

Throws

Create a new role.

Create a role

Throws

Delete a role.

Delete a role

Throws

Remove permissions associated with a role.

Remove permissions from a role

Throws

Retrieve a role.

Get a role

Throws

Retrieve filtered list of roles that can be assigned to users.

Get roles

Throws

Retrieve list of permissions granted by a role.

Get permissions granted by role

Throws

Retrieve users associated with a role. This endpoint supports two types of pagination:

• Offset pagination
• Checkpoint pagination

Checkpoint pagination must be used if you need to retrieve more than 1000 users for a given role.

Checkpoint Pagination

To search by checkpoint, use the following parameters:

• from: Optional id from which to start selection.
• take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.

Note: The first time you call this endpoint using Checkpoint Pagination, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.

Get a role's users

Throws

Update a role.

Update a role

Throws