## List User Groups

`client.iam.userGroups.list(UserGroupListParamsparams, RequestOptionsoptions?): V4PagePaginationArray<UserGroupListResponse>`

**get** `/accounts/{account_id}/iam/user_groups`

List all the user groups for an account.

### Parameters

- `params: UserGroupListParams`

  - `account_id: string`

    Path param: Account identifier tag.

  - `id?: string`

    Query param: ID of the user group to be fetched.

  - `direction?: string`

    Query param: The sort order of returned user groups by name. Default sort order is ascending. To switch to descending, set this parameter to "desc"

  - `fuzzyName?: string`

    Query param: A string used for searching for user groups containing that substring.

  - `name?: string`

    Query param: Name of the user group to be fetched.

  - `page?: number`

    Query param: Page number of paginated results.

  - `per_page?: number`

    Query param: Maximum number of results per page.

### Returns

- `UserGroupListResponse`

  A group of policies resources.

  - `id: string`

    User Group identifier tag.

  - `created_on: string`

    Timestamp for the creation of the user group

  - `modified_on: string`

    Last time the user group was modified.

  - `name: string`

    Name of the user group.

  - `policies?: Array<Policy>`

    Policies attached to the User group

    - `id?: string`

      Policy identifier.

    - `access?: "allow" | "deny"`

      Allow or deny operations against the resources.

      - `"allow"`

      - `"deny"`

    - `permission_groups?: Array<PermissionGroup>`

      A set of permission groups that are specified to the policy.

      - `id: string`

        Identifier of the permission group.

      - `meta?: Meta`

        Attributes associated to the permission group.

        - `key?: string`

        - `value?: string`

      - `name?: string`

        Name of the permission group.

    - `resource_groups?: Array<ResourceGroup>`

      A list of resource groups that the policy applies to.

      - `id: string`

        Identifier of the resource group.

      - `scope: Array<Scope>`

        The scope associated to the resource group

        - `key: string`

          This is a combination of pre-defined resource name and identifier (like Account ID etc.)

        - `objects: Array<Object>`

          A list of scope objects for additional context.

          - `key: string`

            This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

      - `meta?: Meta`

        Attributes associated to the resource group.

        - `key?: string`

        - `value?: string`

      - `name?: string`

        Name of the resource group.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const userGroupListResponse of client.iam.userGroups.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(userGroupListResponse.id);
}
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "created_on": "2024-03-01T12:21:02.0000Z",
      "modified_on": "2024-03-01T12:21:02.0000Z",
      "name": "My New User Group",
      "policies": [
        {
          "id": "f267e341f3dd4697bd3b9f71dd96247f",
          "access": "allow",
          "permission_groups": [
            {
              "id": "c8fed203ed3043cba015a93ad1616f1f",
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "Zone Read"
            },
            {
              "id": "82e64a83756745bbbb1c9c2701bf816b",
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "Magic Network Monitoring"
            }
          ],
          "resource_groups": [
            {
              "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
              "scope": [
                {
                  "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
                  "objects": [
                    {
                      "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                    }
                  ]
                }
              ],
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
            }
          ]
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```