---
title: "Get a list of User Groups"
method: POST
path: "/user_groups/list"
tags: ["user_groups"]
---

# Get a list of User Groups

`POST /user_groups/list`

This operation gets a list of User Groups, allowing for sorting and pagination. Note: Entities that have not been created successfully are not listed.

## Request body

- UserGroupListMetadata — All api calls that return a list will have this metadata block as input
  - `filter` string — The filter in FIQL syntax used for the results.
  - `kind` string — The kind name
  - `sort_order` string — The sort order in which results are returned
  - `offset` integer — Offset from the start of the entity list
  - `length` integer — The number of records to retrieve relative to the offset
  - `sort_attribute` string — The attribute to perform sort on

## Response `200`

Success

- UserGroupListIntentResponse — Response object for intentful operation of user_groups
  - `entities` UserGroupIntentResource[]
    - `status` UserGroupDefStatus — User group status definition.
      - `state` string — The state of the entity.
      - `message_list` MessageResource[]
        - `message` string, required — If state is ERROR, a message describing the error.
        - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
        - `details` object — Custom key-value details relevant to the status.
      - `resources` UserGroupOutputResource, required — User Group Resource Definition.
        - `projects_reference_list` ProjectReference[] — A list of projects the user group is part of.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `directory_service_user_group` DirectoryServiceUserGroupStatus — A Directory Service user group.
          - `distinguished_name` string — The Distinguished name for the user group.
          - `directory_service_reference` DirectoryServiceReference — The reference to a directory_service
            - `kind` string, required — The kind name
            - `name` string
            - `uuid` string, UUID, required
        - `access_control_policy_reference_list` AccessControlPolicyReference[] — List of ACP references.
          - `kind` string, required — The kind name
          - `name` string
          - `uuid` string, UUID, required
        - `display_name` string, required — The display name for the user group.
        - `user_group_type` string
    - `spec` UserGroup — User Group Input Definition.
      - `resources` UserGroupInputResource — User Group Resource Definition
        - `directory_service_user_group` DirectoryServiceUserGroupInput — A Directory Service user group.
          - `distinguished_name` string — The Distinguished name for the user group.
    - `api_version` string
    - `metadata` UserGroupMetadata, required — The user_group kind metadata
      - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when user_group was last updated
      - `kind` string, required — The kind name
      - `uuid` string, UUID — user_group uuid
      - `spec_version` integer — Version number of the latest spec.
      - `creation_time` string, date-time — UTC date and time in RFC-3339 format when user_group was created
      - `spec_hash` string — Hash of the spec. This will be returned from server.
      - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
      - `owner_reference` UserReference — The reference to a user
        - `kind` string, required — The kind name
        - `name` string
        - `uuid` string, UUID, required
      - `categories` object — Categories for the user_group
      - `name` string — user_group name
  - `api_version` string, required
  - `metadata` UserGroupListMetadataOutput, required — All api calls that return a list will have this metadata block
    - `filter` string — The filter used for the results
    - `kind` string — The kind name
    - `sort_order` string — The sort order in which results are returned
    - `offset` integer — Offset from the start of the entity list
    - `total_matches` integer — Total matches found
    - `length` integer — The number of records retrieved relative to the offset
    - `sort_attribute` string — The attribute to perform sort on

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)