accessmanagement - user roles

Updates a specific user role.

This endpoint updates a specific user role, making it easier to maintain clear and accurate role definitions.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive error handling: Returns 400 and 404 error codes with clear descriptions when requests fail.</br>- Reliable user role updates: Facilitates the modification of a specific user role, ensuring accurate and up-to-date information across the system.</br>- Targeted data updates: Leverages the userRoleId parameter in the URL path to update the specified user role, ensuring accurate and focused modifications.

put/accessmanagement/userroles/{userRoleId}

Request

Path parameters

userRoleIdinteger required

Filters data by the user role’s unique identifier.

Request body

namestring
descriptionstring

Example request

{
  "name": "Custom name",
  "description": "Custom role description"
}

Response

User role updated successfully.

idinteger
namestring
roleTypestring
descriptionstring
isSystemRoleboolean
canDeleteboolean
canRenameboolean
resourceGroupCountnumber
userCountnumber
created_tsstring
modified_tsstring

Example response

{
  "id": 1,
  "name": "Admin",
  "roleType": "System Role",
  "description": "Administrator role with full permissions",
  "canRename": true,
  "resourceGroupCount": 1,
  "userCount": 1,
  "created_ts": "2024-12-18T14:06:21.111477+02:00",
  "modified_ts": "2024-12-18T14:06:21.111477+02:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.