# User Domains v3 APIs

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

- [Get All User Domains](#get)
- [Delete a User Domain](#delete)
- [Delete Multiple User Domains](#deleteMultiple)

## Get All User Domains

Retrieves the list of all configured user domain (directory service) details.

**Syntax**

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

**Supported HTTP methods:** GET

**Allowed Roles:** Administrator, User

**Sample Request:**

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

**Sample Response (200 OK):**

```json
{
  "message": "success",
  "data": [
    {
      "id": 1,
      "name": "corp.example.com",
      "controller": "dc01.corp.example.com",
      "port": 389,
      "directoryService": "Active Directory",
      "protocol": "LDAP",
      "userPermissions": "Full Control",
      "saveDomainUserPassword": true
    },
    {
      "id": 2,
      "name": "dev.example.com",
      "controller": "ldap.dev.example.com",
      "port": 636,
      "directoryService": "LDAP",
      "protocol": "LDAPS",
      "userPermissions": "Read Only",
      "saveDomainUserPassword": false
    }
  ],
  "meta": {}
}
```

## Delete a User Domain

Deletes a single user domain by its ID.

**Syntax**

```plaintext
https://[APM-HOST]:[APM-PORT]/api/v3/userdomains/{userDomainId}
```

**Supported HTTP methods:** DELETE

**Allowed Roles:** Administrator

**API Parameters:**

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

**Sample Request:**

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

**Sample Response (200 OK):**

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

## Delete Multiple User Domains

Deletes multiple user domains at once using comma-separated domain IDs.

**Syntax**

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

**Supported HTTP methods:** DELETE

**Allowed Roles:** Administrator

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

**API Parameters:**

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

**Sample Request:**

```plaintext
https://apm-prod-server:8443/api/v3/userdomains
Header:
authorization=c3d0530476e7eb7fbc5345ebea3a89de
Body (form-urlencoded):
userDomainIds=1,3
```

**Sample Response (200 OK):**

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