Получить все подключения к каталогам у партнера

Отдает все подключения к каталогам у партнера

Request

GET

https://corp.browser.yandex.ru/browser/public/api/browser-management/catalog-connections

Responses

200 OK

OK

Body

application/json
{
    "catalogConnectionList": [
        {
            "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,
            "lastSyncStatus": "SUCCESS or FAILED or IN_PROGRESS or NEVER",
            "jobId": "string",
            "lastSyncTime": "string",
            "lastSuccessfulSyncTime": "string",
            "lastSyncId": "string",
            "syncQueueAddedAt": "string"
        }
    ]
}

Name

Description

catalogConnectionList*

Type: ExtendedCatalogConnection[]

Cписок подключений к каталогам
Статус последней синхронизации с каталогом (SUCCESS, FAILED, IN_PROGRESS, NEVER), по умолчанию NEVER
Уникальный идентификатор джобы в очереди задач на синхронизацию
Timestamp даты последней синхронизации с каталогом
Расширенный объект подключения к каталогу

ExtendedCatalogConnection

Name

Description

baseDN*

Type: string

Корень каталога

bindDN*

Type: string

Логин пользователя

createdAt*

Type: string

Timestamp даты создания подключения к каталогу

id*

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

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)

hasContainers

Type: boolean

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

jobId

Type: string

Уникальный идентификатор джобы в очереди задач на синхронизацию

lastSuccessfulSyncTime

Type: string

Timestamp даты последней успешной синхронизации с каталогом

lastSyncId

Type: string

Уникальный идентификатор синхронизации с каталогом

lastSyncTime

Type: string

Timestamp даты последней синхронизации с каталогом

modeContentMinutes

Type: number

Значение в минутах для BY_MS режима синхронизации (минимальный интервал - 1 час = 60 минут)

syncQueueAddedAt

Type: string

Timestamp даты последнего добавления в очередь на синхронизацию

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

No longer supported, please use an alternative and newer version.