Синхронизация пользователей и групп с каталогом LDAP с помощью утилиты ADSCIM

Если в вашей компании развернута служба федерации Active Directory, вы можете настроить автоматическую синхронизацию сотрудников и групп с Яндекс 360 для бизнеса — для этого нужно установить и настроить специальную службу Windows.

Если вы хотите подключить синхронизацию пользователей из Active Directory, установите YandexADSCIM (утилита в виде службы Windows на компьютере) по инструкции ниже и запустите программу от имени пользователя с правами чтения из каталога LDAP. YandexADSCIM управляется через оснастку Сервисы. Настройки меняются в конфигурационном файле.

Сейчас полноценно поддерживаются каталоги Active Directory, Samba DC и Red ADM. Другие каталоги LDAP будут полноценно поддержаны в будущем, когда утилита YandexADSCIM будет портирована на *nix-платформы. Сейчас ее можно использовать для настройки работы с другими каталогами LDAP, но запускать нужно на устройстве с OC Windows.

Подключение и первоначальная настройка ADSCIM

Шаг 1. Начните настройку

1. Проверьте, что единый вход (SSO) подключен и правильно работает. Как подключить единый вход

2. Задайте уникальный идентификатор пользователя:

   • Выберите атрибут Active Directory для передачи в параметр утилиты ADSCIM PropertyLoginName, чтобы внести его в каталог Яндекса:

     • UPN (userPrincipalName в ADSCIM) – если имена для входа пользователей не будут меняться;

     • objectSID, objectGUID или другой — если запланированы изменения домена или бизнес-процессов, которые могут привести к изменению UPN пользователей.

   Внимание

   Атрибут, который вы зададите в качестве основного идентификатора, не должен меняться. Пользователь с другим атрибутом при входе будет считаться новым пользователем.

   • Если ваши пользователи уже используют сервисы Яндекс 360 и проходят аутентификацию с помощью протокола SAML 2.0, проверьте совпадение атрибутов: значение атрибута NameID, которое указано в Active Directory, должно соответствовать основному идентификатору утилиты ADSCIM PropertyLoginName.

   Больше информации про PropertyLoginName см. в шаге 4, п. 2.5.

3. Проверьте, что у пользователей в Active Directory заполнены атрибуты:

   • идентификатор, выбранный в качестве основного;

   • User SamAccountName;

   • E-mail.

Шаг 2. Получите Client ID и OAuth-токен

1. Создайте свое OAuth-приложение по инструкции из Справки OAuth Яндекс ID. При этом:

   • авторизуйтесь в сервисе OAuth с аккаунтом владельца организации;
   • в разделе Доступ к данным введите scim и выберите предлагаемый доступ Управление федерациями.

2. На странице приложения скопируйте:

   • идентификатор приложения из поля ClientID;
   • секретный ключ из поля Client secret.

3. Отправьте POST-запрос, чтобы получить OAuth-токен. Например, через cURL это можно сделать при помощи следующей команды:

   curl -X POST https://oauth.yandex.ru/token -d "grant_type=client_credentials&client_id=значение1&client_secret=значение2"
   

   где значение параметра client_id — это идентификатор созданного приложения, а client_secret — его секретный ключ.

4. Скопируйте значение токена и сохраните его. Оно пригодится на следующих шагах.

Шаг 3. Укажите Client ID в Яндекс 360 и получите Domain ID

1. Откройте кабинет организации в Яндекс 360 для бизнеса. Перейти

2. Перейдите в раздел Общие настройки → Единый вход (SSO).

3. Нажмите Настроить.

4. В блоке Синхронизация SCIM вставьте идентификатор вашего приложения, полученный на шаге 2.

5. Скопируйте ваш Domain ID, он пригодится на следующем шаге.

6. Сохраните изменения.

Шаг 4. Установите и настройте службу Windows для синхронизации

1. Скачайте и установите службу YandexADSCIM. Скачать установочный файл

2. Найдите конфигурационный файл %ProgramData%\Yandex\YandexADSCIM\AD_Users.config и откройте его в любом текстовом редакторе.

   Совет

   Если найти папку %ProgramData% не получается, включите отображение скрытых файлов. Как это сделать

   Каждая настройка в конфигурационном файле записывается отдельной строкой в формате ключ=значение. Строки, которые начинаются с символа #, служба игнорирует.

   Настройте конфигурационный файл:

   1. Проверьте, что в значении параметра LDAP указан правильный путь для подключения к Active Directory. Если нет, исправьте его. Подставьте в поисковые параметры собственные значения.

      Для поискового запроса используйте путь из структуры DIT = Directory Information Tree (читается справа налево):

      LDAP = LDAP://CN=Users,OU=DomainGroup,DC=YourCompanyName,DC=com
      

      где

      • DC – domainComponent, собственный домен и доменная зона;

      • OU – OrganizationUnit, компания, департамент или отдел, из которого вы хотите получить пользователей;

      • CN – commonName, наименование объекта, который хотите получить из каталога.

      Если путей несколько, укажите каждый с новой строки, например:

      LDAP = LDAP://OU=DomainGroup1,DC=YourCompanyName,DC=com
      LDAP = LDAP://OU=DomainGroup2,DC=YourCompanyName,DC=com
      

      Пути объединяются в список и синхронизируются в порядке их указания. Максимальное количество путей не ограничено.

      Конфигурация с несколькими LDAP-путями позволяет подключаться к нескольким лесам Active Directory, если между ними есть доверительные отношения (Trust Relationships).

   2. В значении параметра BearerToken укажите OAuth-токен, полученный на шаге 2.

   3. В значении параметра DomainID укажите ID домена, полученный на шаге 3.

   4. Значение параметра DryRun изначально установлено в значение True. Если оставить это значение, то на данном этапе служба будет работать в тестовом режиме. Запросы будут фиксироваться в логах, но синхронизация производиться не будет. Чтобы включить синхронизацию SCIM уже сейчас, поменяйте значение параметра на False.

   5. Синхронизируйте пользовательские данные из Active Directory. Переназначить атрибуты при создании или синхронизации пользователей в Яндекс 360 позволяют параметры, которые начинаются с Property.

      Параметр PropertyLoginName, который соответствует идентификатору пользователя, может принимать одно из трех значений:

      • userPrincipalName — UPN, значение по умолчанию;

      • objectSID;

      • objectGUID.

      Значение параметра должно соответствовать значению атрибута NameID.

      Если вы используете атрибут вида username, а не username@domain.com, то дополнительно укажите параметр IgnoreUsernameDomain со значением True.

      Для остальных пользовательских атрибутов:

      Название параметра утилиты YandexADSCIM	Название атрибута (рус.)	Значение по умолчанию из Active Directory	Пример
      PropertyFirstName	Имя	givenName	Иван
      PropertyMiddleName	Отчество	middleName	Иванович
      PropertyLastName	Фамилия	sn (SurName)	Иванов
      PropertyDisplayName	Выводимое имя	displayName	Иванов И. И.
      PropertyWorkMail	Основная почта	mail	I_ivanov@domain.ru
      PropertyTitle	Должность	title	Разработчик
      PropertyMobilePhoneNumber	Мобильный телефон	mobile	+7 012 345-67-89
      PropertyWorkPhoneNumber	Рабочий телефон	telephoneNumber	+7 495 123-45-67
      PropertyIpPhoneNumber	IP-телефон	ipPhone	7495 012-34-56

      Параметры, которые начинаются с Property, можно указывать несколько раз — в таком случае значением параметра будет список. Порядок атрибутов при этом важен. Например, для получения фамилии пользователя можно задать атрибуты: PropertyLastName = surName, PropertyLastName = sn, PropertyLastName = lastName. Если существует атрибут surName, будет использовано его значение. Если этого атрибута нет, будет использовано значение атрибута sn. Если он также отсутствует — значение атрибута lastName.

   6. Чтобы запретить блокировку пользователей в Яндекс 360 при синхронизации, добавьте параметр AllowUsersDeletion со значением False. В этом случае пользователи не будут заблокированы в организации Яндекс 360 при удалении их из Active Directory. Значение по умолчанию: True.

   7. Чтобы ограничить выгрузку пользователей, можно воспользоваться фильтром UsersFilter и применить стандартный синтаксис запросов LDAP.

      Если вы указываете несколько LDAP-путей в файле конфигурации, фильтр UsersFilter применяется ко всем путям.

      • Чтобы выбрать пользователей по их членству в определенной группе, используйте фильтр:

        UsersFilter =(memberOf=CN=groupname,CN=Users,DC=domainname,DC=com)
        

      • Если нужно дополнительно исключить из выборки заблокированных в Active Directory пользователей, используйте фильтр:

        UsersFilter =(&(memberOf=CN=groupname,CN=Users,DC=domainname,DC=com) (!(userAccountControl:1.2.840.113556.1.4.803:=2)))
        

        В результате синхронизации пользователи, которые зарегистрированы на почтовом домене вашей организации, но не попали в фильтр, будут заблокированы.

   8. Чтобы синхронизировать алиасы почтовых ящиков из Active Directory:

      • Добавьте параметр EnableAliases со значением True.
      • Укажите алиасы с типом SMTP и префиксом smtp: или SMTP: в атрибуте proxyAdresses пользователя.

      Алиасы автоматически добавятся в аккаунт сотрудника в Яндекс 360 для бизнеса.

      Для корректной синхронизации алиасов версия утилиты YandexADSCIM должна быть 1.1.0.144 или выше. Скачать установочный файл

   9. Для синхронизации алиасов только определенных доменов:

      • Добавьте параметр AliasesDomains.

      • Перечислите домены через пробел:

        AliasesDomains = domain1.com domain2.com domain3.org
        

      Правила обработки почтовых адресов:

      • адрес на домене из AliasesDomains передается как алиас в SCIM;
      • адрес на домене не из списка передается в атрибуте emails с параметром Primary = false;
      • если параметр AliasesDomains отсутствует, синхронизируются алиасы всех доменов организации.
      Как это работает

      Если есть организация с настройками:

      • в организации Яндекс 360 добавлен домен domain1.com;

      • в конфигурации SCIM задано: AliasesDomains = domain2.com;

      • в атрибуте proxyAddresses пользователя в Active Directory указаны адреса:

        • SMTP:user1@domain1.com;
        • smtp:user2@domain2.com;
        • smtp:user3@domain3.com.

      В результате синхронизации в список алиасов пользователя попадут:

      • user1 — домен domain1.com добавлен в организацию Яндекс 360;
      • user2 — домен domain2.com указан в AliasesDomains.

      Адрес user3@domain3.com будет полностью передан в атрибут emails с параметром Primary = false, поскольку домен domain3.com не добавлен в организацию Яндекс 360 и отсутствует в AliasesDomains.

      Параметр AliasesDomains доступен в версии 1.1.0.156 и выше. Скачать установочный файл

   10. Синхронизируйте группы из Active Directory — добавьте параметр EnableGroups со значением True.

       Чтобы ограничить список групп, можно воспользоваться фильтром GroupsFilter и применить стандартный синтаксис запросов LDAP. Например, чтобы выгрузить все списки рассылок, используйте фильтр:

       GroupsFilter =(&(objectClass=group)(!(groupType:1.2.840.113556.1.4.803:=2147483648)))
       

       Если вы указываете несколько LDAP-путей в файле конфигурации, фильтр GroupsFilter применяется ко всем путям.

   11. Чтобы запретить удаление групп в Яндекс 360 при синхронизации, добавьте параметр AllowGroupsDeletion со значением False. В этом случае группы не будут удалены в организации Яндекс 360 при удалении их из Active Directory. Значение по умолчанию: True.

   12. Синхронизируйте атрибуты групп из Active Directory. Переназначить атрибуты при создании или синхронизации групп в Яндекс 360 позволяют параметры, которые начинаются с PropertyGroup.

       Название параметра утилиты YandexADSCIM	Название атрибута (рус.)	Значение по умолчанию из Active Directory	Пример
       PropertyGroupDisplayName	Название	name	Проект интеграции
       PropertyGroupDescription	Описание	description	Сотрудники, участвующие в проекте интеграции
       PropertyGroupEmail	Рассылка	mail	int@domain.ru

       Параметры, которые начинаются с PropertyGroup, можно указывать несколько раз — в таком случае значением параметра будет список. Порядок атрибутов при этом важен. Например, для получения названия группы можно задать атрибуты: PropertyGroupDisplayName = name, PropertyGroupDisplayName = cn. Если существует атрибут name, будет использовано его значение. Если этого атрибута нет, будет использовано значение атрибута cn.

   13. Синхронизируйте внешние контакты, если вы используете их в Яндекс 360. Для этого добавьте параметр EnableContacts со значением True.

       Важно

       Для корректной синхронизации контактов версия утилиты YandexADSCIM должна быть 1.1.0.156 или выше. Скачать установочный файл

       По умолчанию в качестве контактов из Active Directory будут синхронизироваться все объекты, удовлетворяющие LDAP-запросу (&(objectClass=contact)). Чтобы ограничить список контактов, можно воспользоваться фильтром ContactsFilter и применить стандартный синтаксис запросов LDAP. Например, чтобы выгрузить только контакты из группы groupname, используйте фильтр:

       ContactsFilter = (&(objectClass=contact)(memberOf=CN=groupname,CN=Users,DC=domainname,DC=com))
       

       Если вы указываете несколько LDAP-путей в файле конфигурации, фильтр ContactsFilter применяется ко всем путям.

   14. Чтобы запретить удаление контактов в Яндекс 360 при синхронизации, добавьте параметр AllowContactsDeletion со значением False. В этом случае контакты не будут удалены в организации Яндекс 360 при удалении их из Active Directory. Значение по умолчанию: True.

   15. Синхронизируйте атрибуты контактов из Active Directory. Переназначить атрибуты при создании или синхронизации контактов в Яндекс 360 позволяют параметры, которые начинаются с PropertyContact.

       Название параметра утилиты YandexADSCIM	Название атрибута (рус.)	Значение по умолчанию из Active Directory	Пример
       PropertyContactFirstName	Имя	givenName	Иван
       PropertyContactMiddleName	Отчество	middleName	Иванович
       PropertyContactLastName	Фамилия	sn (SurName)	Иванов
       PropertyContactTitle	Должность	title	Разработчик
       PropertyContactDepartment	Отдел	department	Отдел разработки
       PropertyContactCompany	Компания	company	ООО «Страна чудес»
       PropertyContactMail	Основной email*	mail	I_ivanov@domain.ru
       PropertyContactWorkPhone	Основной рабочий телефон	telephoneNumber	+7 495 123-45-67
       PropertyContactOtherWorkPhone	Другие рабочие телефоны	otherTelephone	+7 495 765-43-21
       PropertyContactMobile	Основной мобильный телефон	mobile	+7 012 345-67-89
       PropertyContactOtherMobile	Другие мобильные телефоны	otherMobile	+7 987 654-32-10
       PropertyContactIpPhone	Основной IP-телефон	ipPhone	7495 012-34-56
       PropertyContactOtherIpPhone	Другие IP-телефоны	otherIpPhone	7495 987-65-43
       PropertyContactAddress1	Адрес - Улица	streetAddress	Юбилейная
       PropertyContactAddress2	Адрес - Город	l	Подольск
       PropertyContactAddress3	Адрес - Регион	st	Московская область
       PropertyContactAddress4	Адрес - Индекс	postalCode	142121

       Параметры, которые начинаются с PropertyContact, можно указывать несколько раз — в таком случае значением параметра будет список. Порядок атрибутов при этом важен.

       Каждый из этих параметров также можно отключить, указав для него в качестве значения символ - (минус). Например, чтобы отключить синхронизацию атрибута «Должность», нужно указать PropertyContactTitle = -.

   16. Поменяйте значение параметра DryRun на True перед первым запуском сервиса, если ранее (п. 2.4) вы изменяли его на False. Периодичность запуска сервиса определяется параметром UpdateEveryMins = N, где N  — интервал в минутах. Запустите сервис через оснастку и проанализируйте файл лога.

       Системные сообщения в логах

       Уведомление	Результат
       CORE Update user: user@domain.ru (Active:true -> false)	Пользователь будет заблокирован.
       SCIM Update user	Изменение атрибутов пользователя в каталоге Яндекса.
       SCIM Add user	Добавление пользователя в каталог Яндекса.
       CORE Users: added 0, removed 3 237, modified 0	Добавлено — 0, заблокировано — 3 237, изменено — 0.
       SCIM GET Users: Response is successful	Пользователи успешно зачитаны из каталога Яндекса.
       AD Received user count: N	Из Active Directory загружено N пользователей.
       AD Received groups count: N	Из Active Directory загружено N групп.
       AD_CONFIG Wrong line N	Ошибка в строке N конфигурационного файла.
       AD Received contacts count: N	Из Active Directory загружено N контактов.
       SCIM Add SharedContact:	Добавление контакта в каталог Яндекса.

3. Остановите службу и запустите снова, чтобы применить изменения из конфигурационного файла. Как это сделать

Изменение настроек

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

Просмотр логов

Все логи службы сохраняются в папке %ProgramData%\Yandex\YandexADSCIM. По умолчанию сервис записывает только ключевые этапы работы: запуск службы, загрузку конфигурации, факты получения данных и финальные результаты. Логирование исходящих сетевых запросов отсутствует.

Для включения подробного логирования используйте параметр VerboseLog. Допустимые значения:

• False (по умолчанию) — запись только ключевых событий. Используйте для штатной работы, чтобы избежать избыточного логирования и уменьшить размер журналов.

• True — включает детальное логирование всех этапов и внутренних процессов, включая параметры сетевых запросов к SCIM API: тип запроса, HTTP-заголовки и другие данные. Используйте для отладки, диагностики проблем или аудита работы утилиты YandexADSCIM.

Значения параметра VerboseLog не влияют на обработку данных, а определяют только уровень детализации журналов.

Чтобы ограничить число архивных журналов с расширением .log.gz, используйте параметр MaxLogFileCount. При превышении лимита самые старые файлы будут удаляться во время ротации.

Значения параметра:

• по умолчанию: 14;
• минимум: 2 (любые значения ниже игнорируются).

Обновление ADSCIM

Приложение обновляется автоматически: по умолчанию в конфигурационном файле указано значение AutoUpdate = True либо этого параметра нет, так как значение True является для него значением по умолчанию.

Если вы хотите обновлять приложение вручную, укажите AutoUpdate = False. Теперь, чтобы обновить приложение, вам нужно будет скачать последнюю версию YandexADSCIM (скачать) и запустить установочный файл.

Остановка и перезапуск ADSCIM

YandexADSCIM — это служба Windows, поэтому исполняется автоматически при запуске системы и не зависит от статуса пользователя. Но вы можете отключить ее вручную — для этого в командной строке (cmd.exe) введите sc stop yandexadscim или в диспетчере задач нажмите Остановить.

Для повторного запуска службы в командной строке введите sc start yandexadscim. Также вы можете перезапустить ADSCIM в диспетчере задач на вкладке Службы.

Удаление ADSCIM

Если же вы хотите удалить службу насовсем, используйте команду sc delete yandexadscim.

Возможные ситуации при работе c ADSCIM