Update a role

PUT 
/api/v1/RolesRole/:roleId

Replaces the stored values of a role with the values you send, such as its name, description and the flags that cover all activities, credentials, policies, resources or users. Fields you leave out are reset to their defaults (false, or 0 for the target), so send the full role. The ID in the body must match the ID in the path. Use it to rename a role or change its description.

Permission required: Administrator role.

Values for roleTarget: 0 = AccessPolicies, 1 = Credentials, 2 = Auditors.

Request

Responses

200

Returns the updated role.

400

The IDs in the path and body differ, another role already has that name, or the role could not be updated.

403

The signed-in user does not have the required role, or the account has read-only administrator access.

404

The role does not exist.