Update a Role

Updates parameters of a role

You are able to update name, users, and permissions in a single call.

Any differences between the existing role and fields in the Update call will be applied.

This includes incomplete parameters. The full list of users and permissions must be included in each update call.

For example, if a role has eight permissions and only one is included in the call, the role will be updated to only have the one permission.

⚠️

Permissions rules

Do not include the resource_id field for permissions with a null value.

📘

System fields (id, created_by, created_at, and updated_at) cannot be updated or changed. If included in the Update payload, these fields must be an exact match to the role in the system.

Language