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

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

Важно

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

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

Лицензия открывает доступ к Консоли управления, где вы можете настраивать политики, управлять Сотрудниками и устройствами. Яндекс Браузер для организаций доступен в двух вариантах:

  • Базовая версия — бесплатная, позволяет управлять Браузером через веб-интерфейс Консоли.
  • Расширенная версия — платная, открывает доступ к управлению через API, автоматической синхронизации с каталогом (LDAPS/Active Directory), а также расширенным политикам безопасности.

Чтобы приобрести лицензию:

  1. Перейдите на страницу покупки лицензии.
  2. Выберите количество лицензий под ваш масштаб.
  3. Оформите заказ.

Если у вас есть вопросы по выбору версии или объему лицензий — проконсультируйтесь с нашими специалистами по расширенной версии Браузера.

Примечание

Лицензии привязаны к Яндекс ID. Если лицензии приобретены на личный Яндекс ID, они не отображаются в Консоли при входе в режиме организации. Подробнее см. Подключение и доступ.

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

API-ключ — это токен аутентификации, который нужно передавать в заголовке Authorization при каждом API-запросе к Консоли управления.

Создайте API-ключ

  1. Войдите в веб-версию Консоли управления с Яндекс ID, к которому привязана лицензия, в режиме организации.

    Совет

    Если вы купили лицензии на личный Яндекс ID и они не отображаются в Консоли, поменяйте способ аутентификации.

  2. Перейдите в раздел НастройкиAPI-Токены.

  3. Нажмите Создать токен, задайте название и при необходимости — срок действия.

  4. Скопируйте полученный API-ключ.

    Важно

    Ключ отображается только один раз. Сохраните его в безопасном месте — вы не сможете просмотреть его повторно.

Используйте API-ключ

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

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

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

Content-Type: application/json

{
  "id": "partner_settings_id",
  "partnerId": "partner_123",
  "internalEmployeeMatching": "ACTIVE",
  "externalEmployeeMatching": "INACTIVE"
}
Ошибки аутентификации

Если токен недействителен или не передан, вернется ошибка 401 Unauthorized.

Пример ответа
HTTP/1.1 401 Unauthorized

Content-Type: application/json

{
  "errorCode": "UNAUTHORIZED",
  "errorMessage": "Invalid or missing API token"
}

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

Шаг 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-запрос.

Пример запроса
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. Управляйте регистрационными токенами

Регистрационные токены позволяют подключать Браузеры Сотрудников к Консоли управления. Подготовьте токены заранее — для каждого Сотрудника или Контейнера — и только после этого переходите к подключению Браузеров. С помощью API вы можете получать список токенов, создавать новые, обновлять и удалять существующие.

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

Чтобы создать регистрационный токен, выполните POST-запрос, указав в query-параметрах containerId (для Контейнера) или employeeId (для Сотрудника). В теле запроса передайте описание, количество активаций и срок действия.

  1. Создайте токен для Контейнера.

    Пример запроса
    POST https://corp.browser.yandex.ru/browser/public/api/browser-management/enrollment-token?containerId=019f4684-97ef-7038-9520-250e6b7a96f8
    
    Authorization: <ваш API-токен>
    Content-Type: application/json
    
    {
      "description": "Public API QA container",
      "limit": 6,
      "expiredAt": "2028-01-15T10:00:00.000Z"
    }
    
    Пример ответа
    HTTP/1.1 200 OK
    
    Content-Type: application/json
    
    {
      "enrollmentToken": {
        "id": "019f5a0d-3186-75de-9612-d493d1f50b28",
        "status": "ACTIVE",
        "description": "Public API QA container",
        "limit": 6,
        "activationsLeft": 6,
        "token": "019f5a0d-3186-7a5a-b604-8b1b45ff512e",
        "expiredAt": "2028-01-15T10:00:00.000Z"
      }
    }
    
  2. Создайте токен для Сотрудника.

    Пример запроса
    POST https://corp.browser.yandex.ru/browser/public/api/browser-management/enrollment-token?employeeId=019f4bee-a447-747c-ad57-6f3fa6e76130
    
    Authorization: <ваш API-токен>
    Content-Type: application/json
    
    {
      "description": "Public API QA employee",
      "limit": 4,
      "expiredAt": "2028-02-15T10:00:00.000Z"
    }
    
    Пример ответа
    HTTP/1.1 200 OK
    
    Content-Type: application/json
    
    {
      "enrollmentToken": {
        "id": "019f5a0d-3480-7e54-aa7f-012ad7df4ae3",
        "status": "ACTIVE",
        "description": "Public API QA employee",
        "limit": 4,
        "activationsLeft": 4,
        "token": "019f5a0d-3480-7ff7-b0c0-564aadd16ed0",
        "expiredAt": "2028-02-15T10:00:00.000Z"
      }
    }
    
Ошибки при создании

Если не указать containerId или employeeId, вернется ошибка 400 NOT_ENOUGH_DATA_TO_CONNECT.

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

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

{}
Пример ответа
HTTP/1.1 400 Bad Request

Content-Type: application/json

{
  "errorCode": "NOT_ENOUGH_DATA_TO_CONNECT",
  "errorMessage": "there is not enough data to connect to catalog"
}

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

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

Когда токены подготовлены, зарегистрируйте Браузеры Сотрудников в Консоли. Регистрация привязывает Браузер к конкретному Сотруднику или Контейнеру и позволяет применять к нему политики и лицензии.

Отправьте токен Сотруднику

Самый удобный способ — отправить ссылку и QR-код для регистрации на электронную почту Сотрудника.

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

    Пример запроса
    GET https://corp.browser.yandex.ru/browser/public/api/browser-management/employee-list?employee_fullName_contains=Иван%20Иванов
    
    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. Браузер будет зарегистрирован в Консоли управления.

Получите список зарегистрированных устройств

После регистрации убедитесь, что устройство появилось в Консоли, с помощью GET-запроса.

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

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

Content-Type: application/json

{
  "devices": [
    {
      "id": "device_id_1",
      "employeeId": "1",
      "containerId": null,
      "profileId": "profile_id_1",
      "status": "ACTIVE",
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ]
}

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

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

Лицензия определяет набор функций Браузера, доступных Сотруднику. Ее можно настроить для Контейнера, Сотрудника и Браузера.

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

Получите текущую лицензию профиля

Чтобы узнать, какая лицензия назначена профилю, выполните GET-запрос, указав в пути к ресурсу ID профиля.

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

  2. Получите лицензию профиля.

    Пример запроса
    GET https://corp.browser.yandex.ru/browser/public/api/browser-management/profile/1/licence
    
    Authorization: <ваш API-токен>
    
    Пример ответа
    HTTP/1.1 200 OK
    
    Content-Type: application/json
    
    {
        "id": "link-abc123",
        "profileId": "1",
        "licenceId": "3"
    }
    

Назначьте лицензию профилю

  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
    }
    

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

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

Политики управляют функциями Браузера: блокировкой URL, группами вкладок, параметрами безопасности и другими настройками. Политики задаются в Профиле и применяются ко всем привязанным Контейнерам, Сотрудникам и Браузерам.

Получите список доступных политик

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

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

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

Content-Type: application/json

{
  "policySchemas": [
    {
      "name": "UseTabGroups",
      "description": "Включить или отключить группы вкладок",
      "type": "BOOLEAN"
    },
    {
      "name": "URLBlocklist",
      "description": "Список заблокированных URL",
      "type": "LIST"
    }
  ]
}

Просмотрите политики профиля

Чтобы получить все политики, заданные в конкретном профиле, выполните GET-запрос, указав ID профиля.

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

  2. Получите список политик профиля.

    Пример запроса
    GET https://corp.browser.yandex.ru/browser/public/api/browser-management/profile/1/policies
    
    Authorization: <ваш API-токен>
    
    Пример ответа
    HTTP/1.1 200 OK
    
    Content-Type: application/json
    
    {
      "policies": [
        {
          "id": "1",
          "name": "UseTabGroups",
          "comment": "Включить группы вкладок",
          "state": "ENABLED",
          "policyOption": "RECOMMENDED"
        }
      ]
    }
    

Задайте политику профиля

  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"
    }
    

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

Предыдущая
Следующая