Изменить параметры подключения к каталогу

Изменяет параметры подключения к каталогу

Request

PATCH

https://corp.browser.yandex.ru/browser/public/api/browser-management/catalog-connection/{catalogConnectionId}

Path parameters

Name

Description

catalogConnectionId*

Type: string

Уникальный идентификатор подключения к каталогу

Body

application/json

{
    "status": "ACTIVE or INACTIVE",
    "name": "string",
    "url": "string",
    "baseDN": "string",
    "bindDN": "string",
    "userEmail": "string",
    "userName": "string",
    "userObjectGUID": "string",
    "userDN": "string",
    "userGroups": "string",
    "userObjectClass": "string",
    "userContainersToImport": "string",
    "userFilter": "string",
    "groupName": "string",
    "groupDescription": "string",
    "groupObjectClass": "string",
    "groupContainersToImport": "string",
    "groupFilter": "string",
    "syncMode": "MANUAL or BY_MS",
    "modeContentMinutes": 0,
    "bindCredentials": "string",
    "rootCertificate": "string",
    "lastSyncStatus": "SUCCESS or FAILED or IN_PROGRESS or NEVER",
    "jobId": "string",
    "lastSyncTime": "string"
}

Name	Description
baseDN	Type: string Корень каталога
bindCredentials	Type: string Пароль пользователя
bindDN	Type: string Логин пользователя
groupContainersToImport	Type: string Контейнеры из каталога, которые учитывать в импорте групп
groupDescription	Type: string Название атрибута в каталоге, в котором лежит описание группы (по умолчанию description)
groupFilter	Type: string Фильтр для групп из каталога
groupName	Type: string Название атрибута в каталоге, в котором лежит имя группы (по умолчанию cn)
groupObjectClass	Type: string Название атрибута в каталоге, в котором лежит именование класса группы (по умолчанию group)
jobId	Type: string Уникальный идентификатор джобы в очереди задач на синхронизацию
lastSyncStatus	Type: CatalogConnectionLastSyncStatus Статус последней синхронизации с каталогом (SUCCESS, FAILED, IN_PROGRESS, NEVER), по умолчанию NEVER Example: `SUCCESS or FAILED or IN_PROGRESS or NEVER` Enum: `SUCCESS`, `FAILED`, `IN_PROGRESS`, `NEVER`
lastSyncTime	Type: string Timestamp даты последней синхронизации с каталогом
modeContentMinutes	Type: number Значение в минутах для BY_MS режима синхронизации (минимальный интервал - 1 час = 60 минут)
name	Type: string Имя каталога
rootCertificate	Type: string Корневой сертификат
status	Type: CatalogConnectionStatus Статус подключения (ACTIVE - синхронизация запускается по расписанию если оно есть, INACTIVE - синхронизация не запускается по расписанию), по умолчанию ACTIVE Example: `ACTIVE or INACTIVE` Enum: `ACTIVE`, `INACTIVE`
syncMode	Type: CatalogConnectionSyncMode Режим синхронизации (MANUAL - синхронизация запускается вручную, BY_MS - синхронизация запускается по расписанию или вручную), по умолчанию MANUAL Example: `MANUAL or BY_MS` Enum: `MANUAL`, `BY_MS`
url	Type: string URL каталога
userContainersToImport	Type: string Контейнеры из каталога, которые учитывать в импорте пользователей
userDN	Type: string Название атрибута, который соответствует DN (Distinguished Name) объекта в каталоге (по умолчанию dn)
userEmail	Type: string Название атрибута в каталоге, в котором лежит почта пользователя (по умолчанию mail)
userFilter	Type: string Фильтр для пользователей из каталога
userGroups	Type: string Название атрибута в каталоге, в котором лежат группы пользователя (по умолчанию memberOf)
userName	Type: string Название атрибута в каталоге, в котором лежит имя пользователя (по умолчанию cn)
userObjectClass	Type: string Название атрибута в каталоге, в котором лежит именование класса пользователя (по умолчанию user)
userObjectGUID	Type: string Название атрибута, который соответствует глобально-уникальному идентификатору объекта в каталоге (по умолчанию objectGUID)

CatalogConnectionLastSyncStatus

Статус последней синхронизации с каталогом (SUCCESS, FAILED, IN_PROGRESS, NEVER), по умолчанию NEVER

Type

Description

CatalogConnectionLastSyncStatus

Example: SUCCESS or FAILED or IN_PROGRESS or NEVER

Enum: SUCCESS, FAILED, IN_PROGRESS, NEVER

CatalogConnectionStatus

Статус подключения (ACTIVE - синхронизация запускается по расписанию если оно есть, INACTIVE - синхронизация не запускается по расписанию), по умолчанию ACTIVE

Type

Description

CatalogConnectionStatus

Example: ACTIVE or INACTIVE

Enum: ACTIVE, INACTIVE

CatalogConnectionSyncMode

Режим синхронизации (MANUAL - синхронизация запускается вручную, BY_MS - синхронизация запускается по расписанию или вручную), по умолчанию MANUAL

Type

Description

CatalogConnectionSyncMode

Example: MANUAL or BY_MS

Enum: MANUAL, BY_MS

Responses

200 OK

Body

application/json

{
    "status": "ACTIVE or INACTIVE",
    "name": "string",
    "url": "string",
    "baseDN": "string",
    "bindDN": "string",
    "userEmail": "string",
    "userName": "string",
    "userObjectGUID": "string",
    "userDN": "string",
    "userGroups": "string",
    "userObjectClass": "string",
    "userContainersToImport": "string",
    "userFilter": "string",
    "groupName": "string",
    "groupDescription": "string",
    "groupObjectClass": "string",
    "groupContainersToImport": "string",
    "groupFilter": "string",
    "syncMode": "MANUAL or BY_MS",
    "modeContentMinutes": 0,
    "id": "string",
    "partnerId": "string",
    "createdAt": "string",
    "hasContainers": false
}

Name	Description
baseDN*	Type: string Корень каталога
bindDN*	Type: string Логин пользователя
createdAt*	Type: string Timestamp даты создания подключения к каталогу
hasContainers*	Type: boolean Есть ли у подключения к каталогу контейнеры
id*	Type: string Уникальный идентификатор подключения к каталогу
name*	Type: string Имя каталога
partnerId*	Type: string Уникальный идентификатор партнера
status*	Type: CatalogConnectionStatus Статус подключения (ACTIVE - синхронизация запускается по расписанию если оно есть, INACTIVE - синхронизация не запускается по расписанию), по умолчанию ACTIVE Example: `ACTIVE or INACTIVE` Enum: `ACTIVE`, `INACTIVE`
syncMode*	Type: CatalogConnectionSyncMode Режим синхронизации (MANUAL - синхронизация запускается вручную, BY_MS - синхронизация запускается по расписанию или вручную), по умолчанию MANUAL Example: `MANUAL or BY_MS` Enum: `MANUAL`, `BY_MS`
url*	Type: string URL каталога
groupContainersToImport	Type: string Контейнеры из каталога, которые учитывать в импорте групп
groupDescription	Type: string Название атрибута в каталоге, в котором лежит описание группы (по умолчанию description)
groupFilter	Type: string Фильтр для групп из каталога
groupName	Type: string Название атрибута в каталоге, в котором лежит имя группы (по умолчанию cn)
groupObjectClass	Type: string Название атрибута в каталоге, в котором лежит именование класса группы (по умолчанию group)
modeContentMinutes	Type: number Значение в минутах для BY_MS режима синхронизации (минимальный интервал - 1 час = 60 минут)
userContainersToImport	Type: string Контейнеры из каталога, которые учитывать в импорте пользователей
userDN	Type: string Название атрибута, который соответствует DN (Distinguished Name) объекта в каталоге (по умолчанию dn)
userEmail	Type: string Название атрибута в каталоге, в котором лежит почта пользователя (по умолчанию mail)
userFilter	Type: string Фильтр для пользователей из каталога
userGroups	Type: string Название атрибута в каталоге, в котором лежат группы пользователя (по умолчанию memberOf)
userName	Type: string Название атрибута в каталоге, в котором лежит имя пользователя (по умолчанию cn)
userObjectClass	Type: string Название атрибута в каталоге, в котором лежит именование класса пользователя (по умолчанию user)
userObjectGUID	Type: string Название атрибута, который соответствует глобально-уникальному идентификатору объекта в каталоге (по умолчанию objectGUID)

400 Bad Request

Неверные url или ms выражение (VALIDATION with errors in payload) или не удалось создать секрет с паролем (FAILED_TO_CREATE_VAULT_SECRET или UNKNOWN_ERROR_WHILE_CREATING_VAULT_SECRET)

404 Not Found

У партнера не найдено подключение к каталогу с catalog_connection_id (NO_CATALOG_CONNECTION_FOUND)

Была ли статья полезна?

Получить подключение к каталогу

Выполнить тестовое подключение к каталогу