User roles endpoints
User roles contain sets of permissions. When you assign a user (or a user group) to a
role, you can assign the entire set of permissions at once. This is more organized and
easier to manage than assigning individual permissions to individual users. Use the roles
endpoints to manage roles.
You can:
- GET /roles: Get a list of roles.
- GET /roles/<rid>: Get information about a specific role.
- POST /roles: Create a role.
- PUT /roles/<rid>: Edit a role.
- DELETE /roles/<rid>: Delete a role.
- POST /command/roles/add-users: Assign a role to users.
- POST /command/roles/remove-users: Remove a role from users.
- POST /command/roles/add-groups: Assign a role to user groups.
- POST /command/roles/remove-groups: Remove a role from user groups.
- POST /command/roles/add-permissions: Add permissions to a role.
- POST /command/roles/remove-permissions: Remove permissions from a role.
You'll want to be familiar with the User roles endpoints keys that appear in these endpoints' requests
and responses.
Some command
endpoints are similar to
other endpoints, such as the POST /command/users/add-roles endpoint. However, in
this case, the role is the focus. For example, whereas the POST /command/users/add-roles endpoint assigns multiple
roles to one user, the POST /command/roles/add-users
endpoint assigns one role to multiple users.