---
title: "Lists all available user groups."
method: GET
path: "/accessmanagement/usergroups"
tags: ["accessmanagement - user groups"]
---

# Lists all available user groups.

`GET /accessmanagement/usergroups`

## Request

- Base URL: `https://manager.digicertdns.com/v1`
- URL: `https://manager.digicertdns.com/v1/accessmanagement/usergroups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/digicert/apis/digicert-dns/docs/accessmanagement/usergroups/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `pageSize` integer
- `pageNumber` integer

## Response `200`

User groups listed successfully.

- UserGroupPaginated
  - `data` UserGroup[]
    - `id` integer
    - `name` string
    - `description` string
    - `canDelete` boolean
    - `canRename` boolean
    - `isDefault` boolean
    - `memberCount` integer
    - `resourceGroupsCount` integer
    - `resourceGroupSummary` UserGroupResourceGroupSummary[]
      - `name` string
      - `id` integer
      - `roles` UserGroupRoles[]
        - `id` integer
        - `name` string
        - `description` string
        - `roleType` string
        - `isSystemRole` boolean
        - `canDelete` boolean
        - `canRename` boolean
        - `resourceGroupCount` integer
        - `userCount` integer
        - `modifiedTs` string, date-time
        - `createdTs` string, date-time
  - `total` integer
  - `count` integer
  - `perPage` integer
  - `currentPage` integer
  - `totalPages` integer

## Other responses

- `404`: Resource not found.

---

[API](https://skmtc.dev/digicert/apis/digicert-dns.md) - [All operations](https://skmtc.dev/digicert/apis/digicert-dns/llms.txt) - [OpenAPI document](https://skmtc.dev/digicert/apis/digicert-dns/revisions/c74fc728cff8?raw)