Y360Management

Модуль PowerShell для управления структурой организации Яндекс 360 для бизнеса На основе библиотеки Yandex.API360.

Примеры скриптов можно посмотреть в папке Examples of scripts

Командлеты:

Connect-Y360 - подключиться к API Яндекс 360

Синтаксис:

Connect-Y360 [-OrgId] <string> [-APIToken] <string> [<CommonParameters>]

Параметры:

• OrgId. Обязательный параметр. Задает идентификатор организации.
• APIToken. Обязательный параметр. Задает токен авторизации в API Яндекс 360. Для получения токена ознакомьтесь с официальной документацией Яндекса.

Get-AllowList - получить информацию о белом списке

Синтаксис:

Get-AllowList [<CommonParameters>]

Результат:

Список разрешенных IP-адресов и CIDR-подсетей.

Set-AllowList - редактировать белый список

Синтаксис:

Set-AllowList [[-Items] <StringCollection>] [[-AllowList] <List[string]>] [<CommonParameters>]

Параметры:

• Items. Управление списком разрешенных IP-адресов и CIDR-подсетей. Для добавления адресов в список передайте параметр как показано в следующем примере:

    Set-AllowList -Items @{add="xxx.xxx.xxx.xxx","yyy.yyy.yyy.yyy"}
  

  Для удаления адресов из списка передайте параметр как показано в следующем примере:

    Set-AllowList -Items @{remove="xxx.xxx.xxx.xxx","yyy.yyy.yyy.yyy"}
  

• AllowList. Задает список разрешенных IP-адресов и CIDR-подсетей. Нельзя использовать совместно с параметром Items.

Remove-AllowList - удалить белый список

Синтаксис:

    Remove-AllowList [<CommonParameters>]

Get-Status2FA - получить статус 2FA

Синтаксис:

Get-Status2FA [<CommonParameters>]

Результат:

duration enabled enabledAt
-------- ------- ---------
   0   False

• duration. Период (в секундах), в течение которого при включенной 2FA пользователю в процессе авторизации предлагается настроить 2FA с возможностью пропустить этот шаг. По истечении периода возможность отложить настройку 2FA отключается.
• enabled. Статус обязательной 2FA: true — включена; false — выключена.
• enabledAt. Время включения 2FA.

New-Department - создать подразделение

Синтаксис:

New-Department [-Name] <string> [[-Description] <string>] [[-ExternalId] <string>] [[-Head] <string>] [[-Label] <string>] [[-Parent] <string>] [<CommonParameters>]

Параметры:

• Name. Обязательный параметр. Название подразделения.
• Description. Описание подразделения.
• ExternalId. Произвольный внешний идентификатор подразделения.
• Head. Сотрудник-руководител подразделения. Можно использовать любое значение, которое однозначно определяет сотрудника: Id, Nickname, Email.
• Label. Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.
• Parent. Родительское подразделение. Можно использовать любое значение, которое однозначно определяет подразделение: Id, Email.

Результат:

Возвращает созданное подразделение.

Get-Departments - получение информации о подразделениях

Синтаксис:

Get-Departments [[-Identity] <string>] [[-Filter] <string>] [<CommonParameters>]

Параметры:

• Identity. Обязательный параметр. Определяет подразделение, которое требуется просмотреть. Можно использовать любое значение, которое однозначно определяет подразделение: Id, email.
• Filter. Фильтр. Выполняется поиск по вхождению строки в свойствах name, email, description.

Результат:

Возвращает список подразделений.

Set-Department - изменить информацию о подразделении

Синтаксис:

Set-Department [-Identity] <string> [[-Description] <string>] [[-ExternalId] <string>] [[-Head] <string>] [[-Label] <string>] [[-Name] <string>] [[-Parent] <string>] [[-Aliases] <StringCollection>] [[-AliasList] <List[string]>] [<CommonParameters>]

Параметры:

• Identity. Обязательный параметр. Определяет подразделение, которое требуется изменить. Можно использовать любое значение, которое однозначно определяет подразделение: Id, email.

• Description. Описание подразделения.

• ExternalId. Произвольный внешний идентификатор подразделения.

• Head. Сотрудник-руководител подразделения.

• Label. Имя почтовой рассылки подразделения. Например, для адреса new-department@ваш-домен.ru имя почтовой рассылки — это new-department.

• Name. Название подразделения.

• Parent. Родительское подразделение. Можно использовать любое значение, которое однозначно определяет подразделение: Id, Email.

• Aliases. Параметр для управления алиасами. Для добавления алиаса передайте параметр в виде:

    -Alises @{add="alias1","alias2"}
  

  Для удаления алиаса передайте параметр в виде:

    -Alises @{remove="alias1","alias2"}
  

• AliasList. Список алиасов, не работает совместно с параметром Aliases

Результат:

Возвращает измененное подразделение.

Remove-Department - удалить подразделение

Синтаксис:

Remove-Department [-Identity] <string> [<CommonParameters>]

Параметры:

• Identity.Обязательный параметр. Определяет подразделение, которое требуется изменить. Можно использовать любое значение, которое однозначно определяет подразделение: Id, email.

New-User - создать сотрудника

Синтаксис:

New-User [-NickName] <string> [-FirstName] <string> [-LastName] <string> [[-MiddleName] <string>] [-Password] <string> [[-About] <string>] [[-Birthday] <string>] [[-Contacts] <List[BaseContact]>] [-DepartmentId] <ulong> [[-ExternalId] <string>] [[-Gender] <string>] [-isAdmin] [[-Language] <string>] [[-Position] <string>] [[-Timezone] <string>] [<CommonParameters>]

Параметры:

• NickName. Обязательный параметр. Логин сотрудника.

• FirstName. Обязательный параметр. Имя сотрудника.

• LastName. Обязательный параметр. Фамилия сотрудника.

• MiddleName. Отчество сотрудника.

• Password. Обязательный параметр. Пароль сотрудника.

• About. Описание сотрудника. Формат YYYY-MM-DD.

• Birthday. Дата рождения сотрудника.

• Contacts. Список контактов сотрудника. Массив объектов, содержащих поля:

  • type. Тип контакта. Возможные значения: email; phone_extension; phone; site; icq; twitter; skype.
  • value. Значение контакта.

  Оба поля обязательны для заполнения.

• DepartmentId. Обязательный параметр. Идентификатор подразделения сотрудника.

• ExternalId. Произвольный внешний идентификатор сотрудника.

• Gender. Пол сотрудника.

• isAdmin. Переключатель. Признак администратора организации.

• Language. Язык сотрудника. Например: ru, en.

• Position. Должность сотрудника.

• Timezone. Часовой пояс сотрудника. Например: Europe/Samara, Europe/Moskow.

Результат:

Возвращает созданного сотрудника.

Get-Users - получить информацию о сотрудниках

Синтаксис:

Get-Users [[-Identity] <string>] [[-Filter] <string>] [-EnableOnly] [-DisableOnly] [-AdminOnly] [-RobotOnly] [-DismissedOnly] [[-ResultSize] <int>] [<CommonParameters>]

Параметры:

• Identity. Определяет сотрудника, которого требуется просмотреть.Можно использовать любое значение, которое однозначно определяет сотрудника: Id, nickname, email. Если параметр не используется, то возвращается полный список сотрудников.
• Filter. Фильтр. Выполняется поиск по вхождению строки в свойствах name, nickname, position, email.
• EnableOnly. Указывает, что нужно показать только активных сотрудников.
• DisableOnly. Указывает, что нужно показать только неактивных сотрудников. Не работает совместно с параметром EnableOnly.
• AdminOnly. Указывает, что нужно показать только администраторов
• RobotOnly. Указывает, что нужно показать только пользователей, явзяющихся роботами.
• DismissedOnly. Указывает, что нужно показать только уволенных сотрудников.
• ResultSize. Указывает максимальное число возвращаемых результатов. По умолчанию выводится полный список сотрудников.

Результат:

Возвращает список сотрудников.

Set-User - изменить информацию о сотруднике

Синтаксис:

Set-User [-Identity] <string> [[-About] <string>] [[-Birthday] <string>] [[-Contacts] <List[BaseContact]>] [[-DepartmentId] <ulong>] [[-ExternalId] <string>] [[-Gender] <string>] [[-isAdmin] <bool>] [-Enable] [-Disable] [[-Language] <string>] [[-FirstName] <string>] [[-LastName] <string>] [[-MiddleName] <string>] [[-Password] <string>] [[-Position] <string>] [[-Timezone] <string>] [[-Aliases] <StringCollection>] [<CommonParameters>]

Параметры:

• Identity. Определяет сотрудника, который требуется изменить. Можно использовать любое значение, которое однозначно определяет сотрудника: Id, nickname, email. Если параметр не используется, то возвращается полный список сотрудников.

• About. Описание сотрудника.

• Birthday. Дата рождения сотрудника. Формат YYYY-MM-DD.

• Contacts. Список контактов сотрудника. При передаче в этом параметре пустого массива удаляются контакты, созданные вручную. Автоматически созданную контактную информацию (с флагом synthetic) нельзя изменить или удалить. Пример команды удаления контактов:

    Set-User -Identity nickname -Contacts @()
  

• DepartmentId. Идентификатор подразделения сотрудника.

• ExternalId. Произвольный внешний идентификатор сотрудника.

• Gender. Пол сотрудника.

• isAdmin. Признак администратора организации.

• Enable. Включить сотрудника.

• Disable. Отключить сотрудника, нельзя использовать этот параметр вместе с параметром Enable

• Language. Язык сотрудника. Например: ru, en.

• FirstName. Имя сотрудника.

• LastName. Фамилия сотрудника.

• MiddleName. Отчество сотрудника.

• Password. Пароль сотрудника.

• Position. Должность сотрудника

• Timezone. Часовой пояс сотрудника. Например: Europe/Samara, Europe/Moskow.

• Aliases. Параметр для управления алиасами. Для добавления алиаса передайте параметр в виде:

    -Alises @{add="alias1","alias2"}
  

  Для удаления алиаса передайте параметр в виде:

    -Alises @{remove="alias1","alias2"}
  

Результат:

Возвращает измененного сотрудника.

Get-Status2FAUser - Просмотреть статус 2FA сотрудника

Синтаксис:

Get-Status2FAUser [-Identity] <string> [<CommonParameters>]

Параметры:

• Identity. Определяет сотрудника, которого требуется просмотреть.Можно использовать любое значение, которое однозначно определяет сотрудника: Id, nickname, email.

Результат:

Возвращает true, если у сотрудника включено 2FA, в противном случае возвращает false.

New-Group - создать новую группу

Синтаксис:

New-Group [-Name] <string> [[-Description] <string>] [[-ExternalId] <string>] [[-Label] <string>] [[-Admins] <List[string]>] [[-Members] <List[string]>] [<CommonParameters>]

Параметры:

• Name. Обязательный параметр Название группы.
• Description. Описание группы.
• ExternalId. Произвольный внешний идентификатор группы.
• Label.Имя почтовой рассылки группы. Например, для адреса new-group@ваш-домен.ru имя почтовой рассылки — это new-group.
• Admins. Руководители группы. Можно использовать любое значение, которое однозначно определяет сотрудника: Id, nickname, email.
• Members. Участники группы. Можно использовать любое значение, которое однозначно определяет сотрудника, группу или подразделение: Id, nickname, name, email.

Результат:

Возвращается созданная группа.

Get-Groups - получение информации о группах

Синтаксис:

Get-Groups [[-Identity] <string>] [[-Filter] <string>] [<CommonParameters>]

Параметры:

• Identity. Определяет группу, которую требуется просмотреть. Можно использовать любое значение, которое однозначно определяет группу: Id, name, email. Если параметр не используется, возвращается полный списко групп.
• Filter. Фильтр. Выполняется поиск по вхождению строки в свойствах name, email, description.

Результат:

Возвращается список групп.

Get-GroupMembers - получение информации об участниках группы

Синтаксис:

Get-GroupMembers [-Identity] <string> [<CommonParameters>]

Параметры:

• Identity. Обязательный параметр. Определяет группу, которую требуется просмотреть. Можно использовать любое значение, которое однозначно определяет группу: Id, name, email.

Результат:

departments groups users
----------- ------ -----
{}          {}     {}

• departments. Список подразделений.
• groups. Список групп.
• users. Список сотрудников.

Set-Group - изменить параметры группы

Синтаксис:

Set-Group [-Identity] <string> [[-Name] <string>] [[-Description] <string>] [[-ExternalId] <string>] [[-Members] <StringCollection>] [[-MemberList] <List[string]>] [[-Admins] <StringCollection>] [[-AdminList] <List[string]>] [<CommonParameters>]

Параметры:

• Identity. Обязательный параметр. Определяет группу, которую требуется изменить. Можно использовать любое значение, которое однозначно определяет группу: Id, name, email.

• Name. Название группы.

• Description. Описание группы.

• ExternalId. Произвольный внешний идентификатор группы.

• Members. Параметр для удаления или добавления учасников группы. Для добавления участника передайте параметр в виде:

    -Members @{add="member1","member2"}
  

  Для удаления участника передайте параметр в виде:

    -Members @{remove="member1","member2"}
  

  Можно использовать любое значение, которое однозначно определяет сотрудника, группу или подразделение: Id, nickname, name, email.

• MemberList. Заменить список участников группы. Можно использовать любое значение, которое однозначно определяет сотрудника, группу или подразделение: Id, nickname, name, email. Нельзя использовать совместно с параметром Members.

• Admins. Параметр для удаления или добавления администраторов группы. Для добавления администратора передайте параметр в виде:

    -Admins @{add="admin1","admin2"}
  

  Для удаления администратора передайте параметр в виде:

    -Admins @{remove="admin1","admin2"}
  

  Можно использовать любое значение, которое однозначно определяет сотрудника: Id, nickname, email.

• AdminList. Заменить список администраторов группы. Можно использовать любое значение, которое однозначно определяет сотрудника: Id, nickname, email. Нельзя использовать совместно с параметром Admins.

Remove-Group - удалить группу

Синтаксис:

Remove-Group [-Identity] <string> [<CommonParameters>]

Параметры:

• Identity. Обязательный параметр. Определяет группу, которую требуется удалить. Можно использовать любое значение, которое однозначно определяет группу: Id, name, email.

Get-Organizations - получить список организаций

Синтаксис:

Get-Organizations [[-Filter] <string>] [<CommonParameters>]

Параметры:

• Filter Фильтр. Выполняется поиск по вхождению строки в свойствах name, email.

Результат:

Возвращается список организаций.