---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/ald-pro-api
---

# ALD Pro

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/users/ald-pro
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

## Управление интеграцией с доменами ALD

{% cut "Получение списка присоединенных доменов ALD" %}

```
GET /ald_backend/domains/ald
```

**Ответ на успешный запрос:**

```json5
[
    {
        "id": "string",
        "name": "string",
        "computer_name": "string",
        "dns_ips": ["string"],  
        "status": "string",
        "error": "string"
    },
    ...
]
```

* `id` - идентификатор домена;
* `name` - имя домена, должно быть уникальным;
* `computer_name` - имя компьютера (NGFW Novum) в домене;
* `dns_ips` - список IP-адресов контроллеров домена;
* `status` - статус присоединения к домену:
  * `init` - запущен процесс присоединения;
  * `completed` - процесс присоединения завершен успешно;
  * `error` - процесс присоединения завершен с ошибкой.
* `error` - описание ошибки, возникшей при присоединении к домену, если параметр `status` содержит значение `error`. Может быть пустым.

{% endcut %}

{% cut "Ввод NGFW Novum в домен ALD" %}

```
POST /ald_backend/domains/ald
```

**JSON-тело запроса:**

```json5
{
    "name": "string",
    "computer_name": "string",
    "dns_ips": ["string"],
    "user": "string",
    "password": "string"
}
```

* `name` - имя домена;
* `computer_name` - имя компьютера (NGFW Novum) в домене;
* `dns_ips` - список IP-адресов контроллеров домена;
* `user` - имя пользователя, имеющего права на ввод компьютера в домен;
* `password` - пароль пользователя.

**Ответ на успешный запрос:**

```json5
{
    "id": "string"
}
```

* `id` - идентификатор домена.

{% endcut %}

{% cut "Удаление интеграции с доменом ALD" %}

```
DELETE /ald_backend/domains/ald/<id домена>
```

Удалить можно только домены со статусом **error** или **complete**.

**Ответ на успешный запрос:** 200 OK

{% endcut %}

## Управление списками групп и подразделений

{% cut "Получение списка групп в заданном домене" %}

```
GET /ald_backend/domains/<id домена>/security_groups
```

**Ответ на успешный запрос:**

```json5
[
    {
        "name": "string",
        "guid": "string"
    },
    ...
]
```

* `name` - имя группы;
* `guid` - идентификатор группы.

{% endcut %}

{% cut "Получение структуры подразделений в заданном домене" %}

```
GET /ald_backend/domains/<id домена>/tree
```

**Ответ на успешный запрос:**

```json5
[
    {
        "name": "string",
        "guid": "string",
        "parent_guid": "string" | null
    },
    ...
]
```

* `name` - имя подразделения;
* `guid` - идентификатор подразделения;
* `parent_guid` - идентификатор родительской группы.

{% endcut %}
