---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/ldap-filters-api
---

# LDAP-фильтры

::: 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/ldap
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

{% cut "Создание LDAP-фильтра" %}

```
POST /api/ldap-filters
```

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

```json5
{
    "name": "string",
    "comment": "string",
    "catalog": "string",
    "container_guid": "string",
    "search_filter": "string"
}
```

* `name` - название LDAP-фильтра. Максимальная длина - 128 символов. Не может быть пустым;
* `comment` - комментарий. Максимальная длина - 256 символов. Может быть пустым;
* `catalog` - идентификатор интеграции с каталогом AD вида `catalog.id.ad.<идентификатор>`. Не может быть пустым;
* `container_guid` - идентификатор LDAP-контейнера, из которого берутся пользователи. Не может быть пустым;
* `search_filter` - выражение дополнительного фильтра, который объединяется с фильтром по-умолчанию `{objectClass=user}` через логическое `И`. Может быть пустым.

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

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

* `id` - идентификатор созданного объекта LDAP-фильтра.

{% endcut %}

{% cut "Получение списка LDAP-фильтров" %}

```
GET /api/ldap-filters
```

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

```json5
[
    {
        "id": "string",
        "name": "string",
        "comment": "string",
        "catalog": "string",
        "container_guid": "string",
        "search_filter": "string"
    },
    ...
]  
```

* `id` - идентификатор созданного объекта LDAP-фильтра;
* `name` - название LDAP-фильтра. Максимальная длина - 128 символов. Не может быть пустым;
* `comment` - комментарий. Максимальная длина - 256 символов. Может быть пустым;
* `catalog` - идентификатор интеграции с каталогом AD вида `catalog.id.ad.<идентификатор>`. Не может быть пустым;
* `container_guid` - идентификатор LDAP-контейнера, из которого берутся пользователи. Не может быть пустым;
* `search_filter` - выражение дополнительного фильтра, который объединяется с фильтром по-умолчанию `{objectClass=user}` через логическое `И`. Может быть пустым.

{% endcut %}

{% cut "Редактирование LDAP-фильтра" %}

```
PATCH /api/ldap-filters/<id>
```

`id` - идентификатор объекта LDAP-фильтра.

**Json-тело запроса (все или некоторые поля):**

```json5
{
    "name": "string",
    "comment": "string",
    "catalog": "string",
    "container_guid": "string",
    "search_filter": "string"
}
```

* `name` - название LDAP-фильтра. Максимальная длина - 128 символов. Не может быть пустым;
* `comment` - комментарий. Максимальная длина - 256 символов. Может быть пустым;
* `catalog` - идентификатор интеграции с каталогом AD вида `catalog.id.ad.<идентификатор>`. Не может быть пустым;
* `container_guid` - идентификатор LDAP-контейнера, из которого берутся пользователи. Не может быть пустым;
* `search_filter` - выражение дополнительного фильтра, который объединяется с фильтром по-умолчанию `{objectClass=user}` через логическое `И`. Может быть пустым.

Поля, которые не нужно редактировать, должны отсутствовать в теле запроса.

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

{% endcut %}

{% cut "Удаление LDAP-фильтра" %}

```
DELETE /api/ldap-filters/<id>
```

`id` - идентификатор объекта LDAP-фильтра.

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

{% endcut %}
