Быстрый старт

Настроить Консоль управления можно как в веб-версии, так и через API.

Важно

Настройка Консоли управления через API доступна в расширенной версии Браузера.

Шаг 1. Приобретите лицензию

Купите лицензию. Перед покупкой вы можете проконсультироваться с нашими специалистами по расширенной версии Браузера.

Шаг 2. Получите API-ключ

  1. Войдите в веб-версию Консоли управления с Яндекс ID, к которому привязана лицензия, в режиме организации. Если вы купили лицензии на личный Яндекс ID, то они не будут отображаться в Консоли после входа в режиме организации. Чтобы отобразить эти лицензии и управлять ими, поменяйте способ аутентификации.

  2. В разделе Настройки → API-Токены нажмите Создать токен.

  3. Скопируйте полученный API-ключ и используйте его в HTTP-заголовке Authorization во всех запросах. Например, так можно получить настройки партнера:

    GET http://corp.browser.yandex.ru/browser/public/api/browser-management/partner-settings

Authorization: {ваш токен}

Шаг 3. Создайте Оргструктуру

Оргструктура в Консоли может быть двух типов:

  • внешняя — данные синхронизируются с основной системой структуры организации;
  • локальная — самостоятельно создайте структуру в интерфейсе Консоли.

Подключите внешнюю Оргструктуру по протоколу LDAPS из каталога (например, Active Directory). Чтобы подключиться к каталогу, выполните POST-запрос.

Пример запроса
POST https://corp.browser.yandex.ru/browser/public/api/browser-management/catalog-connection

Authorization: <ваш API-токен>
Content-Type: application/JSON

{
  "status": "ACTIVE",
  "name": "Example Catalog",
  "url": "ldap://example.com:389",
  "baseDN": "dc=example,dc=com",
  "bindDN": "cn=admin,dc=example,dc=com",
  "userEmail": "mail",
  "userName": "cn",
  "userObjectGUID": "objectGUID",
  "userDN": "dn",
  "userGroups": "memberOf",
  "userObjectClass": "user",
  "userContainersToImport": "ou=Users,dc=example,dc=com",
  "userFilter": "(objectClass=user)",
  "groupName": "cn",
  "groupDescription": "description",
  "groupObjectClass": "group",
  "groupContainersToImport": "ou=Groups,dc=example,dc=com",
  "groupFilter": "(objectClass=group)",
  "syncMode": "BY_MS",
  "modeContentMinutes": 60,
  "bindCredentials": "admin_password",
  "rootCertificate": "-----BEGIN CERTIFICATE-----\nMIID...\n-----END CERTIFICATE-----"
}
Пример ответа
HTTP/1.1 200 OK

Content-Type: application/JSON

{
  "status": "ACTIVE",
  "name": "Example Catalog",
  "url": "ldap://example.com:389",
  "baseDN": "dc=example,dc=com",
  "bindDN": "cn=admin,dc=example,dc=com",
  "userEmail": "mail",
  "userName": "cn",
  "userObjectGUID": "objectGUID",
  "userDN": "dn",
  "userGroups": "memberOf",
  "userObjectClass": "user",
  "userContainersToImport": "ou=Users,dc=example,dc=com",
  "userFilter": "(objectClass=user)",
  "groupName": "cn",
  "groupDescription": "description",
  "groupObjectClass": "group",
  "groupContainersToImport": "ou=Groups,dc=example,dc=com",
  "groupFilter": "(objectClass=group)",
  "syncMode": "BY_MS",
  "modeContentMinutes": 60,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "partnerId": "partner_123",
  "createdAt": "2023-10-01T12:00:00Z",
  "hasContainers": true
}

Подробнее см. Список методов для работы с каталогами.

Создайте корневой Контейнер с названием компании, а внутри него — вложенные Контейнеры, которые соответствуют структурным подразделениям организации (например, департаментам и отделам). Распределите Сотрудников по Контейнерам с названиями их подразделений.

Создайте контейнер

Контейнеры позволяют применять набор политик к привязанным сотрудникам и вложенным контейнерам. Чтобы создать контейнер, выполните POST-запрос.

Пример запроса
POST https://corp.browser.yandex.ru/browser/public/api/browser-management/container

Authorization: <ваш API-токен>
Content-Type: application/JSON
    
{
  "name": "container"
}
Пример ответа
HTTP/1.1 200 OK

Content-Type: application/JSON

{
    "createdAt":"2025-05-07T10:21:54.570Z",
    "description":null,
    "id":"id",
    "name":"container",
    "partnerId":"partnerId",
    "profileId":null,
    "catalogConnectionId":null,
    "hasNestedContainers":false,
    "parentId":null
}
Удалить контейнер

Запрос удаляет контейнер с внутренними контейнерами, сотрудниками и устройствами и привязанные к ним токены и политики.

  1. Получите ID контейнера с помощью GET-запроса.

  2. Чтобы удалить сотрудников, выполните DELETE-запрос.

    Пример запроса
    DELETE https://corp.browser.yandex.ru/browser/public/api/browser-management/container/12345

Authorization: <ваш API-токен>
    Пример ответа
    HTTP/1.1 200 OK

Content-Type: application/JSON

{
  "deletedContainerIds": [
        "12345"
    ]
}

Добавьте сотрудников

Чтобы добавить списком, используйте метод с файлом CSV. Заполните шаблон, проверьте его корректность и выполните POST-запрос. При этом сотрудники привязываются к профилю из пути к ресурсу {profileId}.

Пример запроса
POST https://corp.browser.yandex.ru/browser/public/api/browser-management/container/{containerId}/employee/csv ?

*overrideDuplicate=<true/false>

Authorization: <ваш API-токен>
Content-Type: multipart/form-data

{
    "employeesInfo": "binary"
}
Пример ответа
HTTP/1.1 200 OK

Content-Type: application/JSON

{
    "createdEmployees": [
        {
            "id": "1",
            "departmentId": "Бухгалтерия",
            "email": "example@ya.ru",
            "fullName": "Иван Иванов",
            "profileId": "1",
            "source": "CSV_FILE"
        }
    ],
    "departments": [
        {
            "id": "1",
            "name": "Бухгалтерия"
        }
    ]
}
Удалить сотрудника

  1. Получите ID сотрудников с помощью GET-запроса.

  2. Чтобы удалить сотрудников, выполните DELETE-запрос.

    Пример запроса
    DELETE https://corp.browser.yandex.ru/browser/public/api/browser-management/employees

Authorization: <ваш API-токен>
Content-Type: application/JSON

{
    "employeeIds": [
    "employee_id_1",
    "employee_id_2",
    "employee_id_3"
    ]
}
    Пример ответа
    HTTP/1.1 200 OK

Content-Type: application/JSON

[
{
    "id": "employee_id_1",
    "departmentId": "department_id_1",
    "email": "employee1@example.com",
    "fullName": "Иванов Иван Иванович",
    "userLogin": "ivanovii",
    "profileId": "profile_id_1",
    "source": "CSV_FILE"
},
{
    "id": "employee_id_2",
    "departmentId": "department_id_2",
    "email": "employee2@example.com",
    "fullName": "Петров Петр Петрович",
    "userLogin": "petrovpp",
    "profileId": "profile_id_2",
    "source": "MANUAL"
},
{
    "id": "employee_id_3",
    "departmentId": "department_id_1",
    "email": "employee3@example.com",
    "fullName": "Сидоров Сидор Сидорович",
    "userLogin": "sidorovsks",
    "profileId": "profile_id_3",
    "source": "API"
}
]

Шаг 4. Подключите Браузер к управлению

Зарегистрируйте Браузеры сотрудников в Консоли.

  1. Получите ID сотрудников с помощью GET-запроса.

    Пример запроса
    GET https://corp.browser.yandex.ru/browser/public/api/browser-management/employee-list

[employee_fullName_contains=<Иван Иванов>]
& [employee_fullName_contains=<Петр Петров>]
& [employee_fullName_mode=<insensitive>]

Authorization: <ваш API-токен>
    Пример ответа
    HTTP/1.1 200 OK

Content-Type: application/JSON

{
    "employees": [
        {
        "id": "1",
        "departmentId": "1",
        "email": "example-1@ya.ru",
        "fullName": "Иван Иванов",
        "profileId": "1",
        "source": "CSV_FILE"
        },
        {
        "id": "2",
        "departmentId": "1",
        "email": "example-2@ya.ru",
        "fullName": "Петр Петров",
        "profileId": "1",
        "source": "CSV_FILE"
        },
    ]
}

  2. Отправьте токен в виде ссылки и QR-кода на электронную почту пользователя с помощью POST-запроса.

    Пример запроса
    POST https://corp.browser.yandex.ru/browser/public/api/browser-management/employees/sendEmails

Authorization: <ваш API-токен>
Content-Type: application/JSON

{
  "employees": [
    {
      "email": "example-1@ya.ru",
      "employeeId": "1"
    },
    {
      "email": "example-2@ya.ru",
      "employeeId": "2"
    }
  ]
}
    Пример ответа
    HTTP/1.1 200 OK

Content-Type: application/JSON

  3. Пользователь откроет ссылку в Браузере.

  4. Браузер будет зарегистрирован в Консоли управления.

Шаг 5. Настройте лицензии

Лицензию можно настроить для Контейнера, Сотрудника и Браузера.

Приоритет при наследовании лицензии (от меньшего к большему): материнский Контейнер → Контейнер → Сотрудник → Браузер. Например, если задана лицензия для конкретного Браузера, то используется именно она, независимо от значений Сотрудника или вышестоящего Контейнера.

  1. Получите ID профиля Контейнеров, Сотрудников или Устройств с помощью GET-запросов.

  2. Назначьте лицензию профилю. Для этого выполните PUT-запрос, указав в пути к ресурсу ID профиля.

    Пример запроса
    PUT https://corp.browser.yandex.ru/browser/public/api/browser-management/profile/1/licence?licence_id=3

Authorization: <ваш API-токен>
    Пример ответа
    HTTP/1.1 200 OK

Content-Type: application/JSON

{
    "id": "link-abc123",
    "profileId": "1",
    "licenceId": "3"
}
Удалить лицензию

  1. Получите ID профиля Контейнеров, Сотрудников или Устройств с помощью GET-запросов.

  2. Чтобы удалить лицензию, выполните DELETE-запрос.

    Пример запроса
    DELETE https://corp.browser.yandex.ru/browser/public/api/browser-management/profile/67890/licence

Authorization: <ваш API-токен>
    Пример ответа
    HTTP/1.1 200 OK
Content-Type: application/JSON

{
    "deletedLicenceProfileRelations": 1
}

Шаг 6. Настройте групповые политики

  1. Получите ID профиля Контейнеров, Сотрудников или Устройств с помощью GET-запросов.

  2. Задайте политики в профиле. Для этого выполните PUT-запрос, указав в пути к ресурсу ID профиля и название политики.

    Пример запроса
    PUT https://corp.browser.yandex.ru/browser/public/api/browser-management/profile/1/policy/UseTabGroups

Authorization: <ваш API-токен>
Content-Type: application/JSON

{
    "comment": "Включить группы вкладок",
    "state": "ENABLED",
    "policyOption": "RECOMMENDED"
}
    Пример ответа
    HTTP/1.1 200 OK

Content-Type: application/JSON

{
    "id": "1",
    "name": "UseTabGroups",
    "comment": "Включить группы вкладок",
    "state": "ENABLED",
    "policyOption": "RECOMMENDED"
}
Предыдущая
Введение
Следующая
Глоссарий