# User Groups v3 APIs

The User Groups v3 APIs allow you to perform various operations to user groups configured under User Management in the system. Browse through the following APIs to perform required operations to user groups:

- [Get All User Groups](https://www.manageengine.com/products/applications_manager/help/user-groups-v3-apis.html#get)
- [Delete a User Group](https://www.manageengine.com/products/applications_manager/help/user-groups-v3-apis.html#delete)
- [Delete Multiple User Groups](https://www.manageengine.com/products/applications_manager/help/user-groups-v3-apis.html#deleteMultiple)

## Get All User Groups

Retrieves the list of all configured user groups.

**Syntax**

```
https://[APM-HOST]:[APM-PORT]/api/v3/usergroups
```

**Supported HTTP methods:** GET

**Allowed Roles:** Administrator, User

**Sample Request:**

```
https://apm-prod-server:8443/api/v3/usergroups
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
```

**Sample Response (200 OK):**

```json
{
  "message": "success",
  "data": [
    {
      "id": 1,
      "name": "Network Team",
      "authentication": "Local Authentication",
      "domainName": "-",
      "userLoginRole": "Administrator",
      "userProfile": [
        "admin",
        "john.doe"
      ],
      "monitorGroup": [
        "Production Servers",
        "Database Monitors"
      ]
    },
    {
      "id": 2,
      "name": "DevOps Group",
      "authentication": "Domain Authentication",
      "domainName": "corp.example.com",
      "userLoginRole": "Operator",
      "userProfile": [
        "jane.smith"
      ],
      "monitorGroup": [
        "Web Servers"
      ]
    }
  ],
  "meta": {}
}
```

## Delete a User Group

Deletes a single user group by its ID.

**Syntax**

```
https://[APM-HOST]:[APM-PORT]/api/v3/usergroups/{userGroupId}
```

**Supported HTTP methods:** DELETE

**Allowed Roles:** Administrator

**API Parameters:**

| Parameter | Type | Required | Description |
|---|---|---|---|
| **Path Parameter** |  |  |  |
| `userGroupId` | Long | Yes | The unique ID of the user group |

**Sample Request:**

```
https://apm-prod-server:8443/api/v3/usergroups/2
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
```

**Sample Response (200 OK):**

```json
{
  "message": "success",
  "data": [
    "am.webclient.useradministration.usergroup.delete.success"
  ],
  "meta": {}
}
```

## Delete Multiple User Groups

Deletes multiple user groups at once using comma-separated user group IDs.

**Syntax**

```
https://[APM-HOST]:[APM-PORT]/api/v3/usergroups
```

**Supported HTTP methods:** DELETE

**Allowed Roles:** Administrator

**Content-Type:** `application/x-www-form-urlencoded`

**API Parameters:**

| Parameter | Type | Required | Description |
|---|---|---|---|
| **Request Parameter** |  |  |  |
| `userGroupIds` | String | Yes | Comma-separated list of user group IDs |

**Sample Request:**

```
https://apm-prod-server:8443/api/v3/usergroups
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
Body (form-urlencoded):
userGroupIds=2,4,6
```

**Sample Response (200 OK):**

```json
{
  "message": "success",
  "data": [
    "am.webclient.useradministration.usergroup.delete.success"
  ],
  "meta": {}
}
```