DIdigicert
accessmanagement - user groups

Lists all available user groups.

This endpoint lists all available user groups, enabling users to review and manage existing groups 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 groups, 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 groups 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/usergroups

Request

Query parameters

pageSizeinteger

The maximum number of user groups 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 groups listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": 27,
      "name": "Default",
      "description": "Default user group",
      "canRename": true,
      "isDefault": true,
      "resourceGroupsCount": 20,
      "resourceGroupSummary": [
        {
          "name": "Default resource group",
          "id": 128,
          "roles": [
            {
              "id": 3,
              "name": "Admin",
              "description": "Administrator role with full permissions",
              "roleType": "System Role",
              "userCount": 1,
              "modifiedTs": "2025-09-01T15:37:56.338909+02:00",
              "createdTs": "2025-09-01T15:37:56.338859+02:00"
            }
          ]
        }
      ]
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

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