accessmanagement - user roles

Returns the details of a specific user role.

This endpoint returns the details of a specific user role, enabling users to understand its permissions and configuration.</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>- Targeted data retrieval: Employs the userRoleId parameter to return the specified user role's details, ensuring accuracy and relevance in the response.

get/accessmanagement/userroles/{userRoleId}

Request

Path parameters

userRoleIdinteger required

Filters data by the user roles’s unique identifier.

Response

User role returned 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.