DIdigicert
accessmanagement - user roles

Lists all available user roles.

This endpoint lists all available user roles, helping users manage and review the roles available within the system.</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 data retrieval: Returns a comprehensive list of all user roles, providing a complete and accurate overview for seamless management and analysis.</br>- Controlled data limits: The pageSize parameter allows users to define the maximum number of user roles to display per page, optimizing data retrieval for specific use cases.</br>- Customizable pagination: The pageNumber parameter allows users to specify the page of results they wish to retrieve, ensuring targeted access to data.

get/accessmanagement/userroles

Request

Query parameters

pageSizeinteger

The maximum number of user roles to return per page. Defaults to 25 if not specified.

pageNumberinteger

The page of results to return. Defaults to 0 if not specified.

Response

User roles listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

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