N-able Cloud User Hub (предварительная версия)
Cloud User Hub — это единый портал Microsoft CSP, который позволяет автоматизировать распространенные задачи во всех приложениях Microsoft 365 без переключения консоли или клиентов.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка облачного центра пользователей |
| URL | https://documentation.clouduserhub.management/kb/en |
| Адрес электронной почты | technicalsupport@n-able.com |
| Метаданные соединителя | |
|---|---|
| Publisher | N-able Cloud User Hub B.V. |
| Website | https://www.n-able.com |
| Политика конфиденциальности | https://www.n-able.com/legal/privacy |
| Категории | Управление бизнесом;ИТ-операции |
Cloud User Hub — это единый портал Microsoft CSP, который позволяет автоматизировать распространенные задачи во всех приложениях Microsoft 365 без переключения консоли или клиентов.
Предпосылки
Для продолжения вам потребуется следующее:
- Подписка Cloud User Hub
- Настроенные решения в Cloud User Hub для конкретных операций, которые вы планируете использовать
- Настроенные роли в Cloud User Hub для конкретных операций, которые вы планируете использовать.
Получение учетных данных
Вы можете войти с любой учетной записью, настроенной для доступа к Cloud User Hub. Для сценариев автоматизации рекомендуется использовать выделенную учетную запись службы.
Начало работы с соединителем
Начните с Получения организаций, чтобы получить список организаций, которым разрешено управлять (включая собственные). Организации возвращаются в соответствии с настроенными областями ролей в Cloud User Hub. Используйте идентификаторы для последовательных вызовов. Для операций, требующих идентификатора партнера, используйте идентификатор из собственной организации. Для некоторых операций вам потребуется идентификатор клиента, а не внутренний идентификатор Пользовательского центра облака или оба.
Известные проблемы и ограничения
Для некоторых операций требуется, чтобы у целевой организации была соответствующая лицензия Microsoft 365 и (или) активная подписка Azure. Например, для настройки условного доступа требуется лицензия Microsoft Entra ID Premium.
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка доменов организации |
Получение списка объектов домена. |
| Добавление задания блока команд для группы |
Добавление задания блока команд. Проверка поставщика и действия основана на определенном блоке команд. |
| Добавление задания блока команд для организации |
Добавление задания блока команд. Проверка поставщика и действия основана на определенном блоке команд. |
| Добавление задания блока команд для пользователя |
Добавление задания блока команд. Проверка поставщика и действия основана на определенном блоке команд. |
| Добавление участника в группу |
Добавьте участника в группу Microsoft 365 или группу безопасности через свойство навигации членов. |
| Добавление участника в группу пользователей |
Добавьте участника в группу пользователей, член должен принадлежать той же организации, что и группа. |
| Назначение лицензии пользователю |
Добавление или удаление лицензий для пользователя. Вы также можете включить и отключить определенные планы, связанные с лицензией. |
| Обновление количества подписок |
Обновите количество подписки. |
| Пароль изменения пользователя |
Обновите профиль пароля пользователя, чтобы сбросить пароль. |
| Перечисление блоков команд |
Получите список доступных блоков команд. |
| Получение групп безопасности Azure AD |
Получите список групп безопасности Azure AD всех организаций, которые вы авторизованы для просмотра. |
| Получение групп пользователей Cloud User Hub |
Получите список групп всех организаций, которые вы авторизованы для просмотра. |
| Получение заданий блока команд для всех авторизованных организаций |
Получение заданий блока команд для блоков команд, которые вы авторизованы для просмотра. |
| Получение заданий блока команд определенной организации |
Получение заданий блока команд для блоков команд, которые вы авторизованы для просмотра. |
| Получение категорий команд |
Получение всех доступных категорий и подкатегорий. |
| Получение номеров SKU, подписанных организацией |
Получите список коммерческих подписок, приобретенных организацией. |
| Получение организаций |
Получите все организации, которые вы авторизованы для просмотра. |
| Получение подписок |
Извлекает все подписки для клиента партнера по идентификатору клиента Active Directory. |
| Получение пользователей |
Получение списка объектов пользователя. |
| Получение сведений о блоке команд |
Получение сведений о блоке команд. Проверка поставщика и действия зависят от конкретного блока команд. |
| Получение сведений о лицензии пользователя |
Получение списка объектов сведений о лицензии для корпоративных пользователей. |
| Получение сведений о пользователе |
Получение пользователя по идентификатору объекта Майкрософт. |
| Получение сведений об одном задании пользователя |
Получение сведений об одном задании пользователя, поставщике и проверке действий зависит от конкретного блока команд. |
| Получение списка участников группы пользователей Cloud User Hub |
Получите список членов группы пользователей определенной группы. |
| Получение статистики заданий блока команд для всех авторизованных организаций |
Получите статистику по заданиям блока команд для блоков команд, которые вы авторизованы для просмотра. |
| Получение языковых стандартов |
Получение языковых стандартов. |
| Создание группы Azure AD |
Создайте группу Azure AD. |
| Создание пользователя |
Текст запроса содержит пользователя для создания. Как минимум, необходимо указать необходимые свойства для пользователя. При необходимости можно указать любые другие доступные для записи свойства. |
| Удаление группы пользователей Cloud User Hub |
Удаление группы пользователей. |
| Удаление пользователя |
Удаление пользователя. При удалении ресурсы пользователей перемещаются во временный контейнер и могут быть восстановлены в течение 30 дней. По истечении этого периода они удаляются без возможности восстановления. |
| Удаление члена |
Удалите члена из группы с помощью свойства навигации членов. |
| Удаление члена из группы пользователей |
Удалите участника в группу пользователей. |
Вывод списка доменов организации
Получение списка объектов домена.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of object |
Ценность. |
|
Тип аутентификации
|
value.authenticationType | string |
Тип проверки подлинности домена. |
|
Состояние доступности
|
value.availabilityStatus | string |
Состояние доступности домена. |
|
Идентификатор
|
value.id | string |
Идентификатор домена. |
|
Управляемый администратором
|
value.isAdminManaged | boolean |
Указывает, управляет ли домен администратором. |
|
По умолчанию
|
value.isDefault | boolean |
Указывает, является ли это доменом по умолчанию. |
|
Начальный
|
value.isInitial | boolean |
Указывает, является ли это начальным доменом. |
|
Корень
|
value.isRoot | boolean |
Указывает, является ли это корневым доменом. |
|
Проверено
|
value.isVerified | boolean |
Указывает, проверен ли домен. |
|
поддерживаемые службы
|
value.supportedServices | array of string |
Поддерживаемые службы. |
|
Срок действия пароля
|
value.passwordValidityPeriodInDays | integer |
Указывает срок действия пароля в днях. |
|
Окна уведомлений о паролях
|
value.passwordNotificationWindowInDays | integer |
Указывает окно уведомления паролей в днях. |
|
Государство
|
value.state | string |
Состояние домена. |
Добавление задания блока команд для группы
Добавление задания блока команд. Проверка поставщика и действия основана на определенном блоке команд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
organizationId | True | string |
Формат — uuid. Уникальный идентификатор организации. |
|
Идентификатор блока команд
|
commandBlockId | True | string |
Формат — uuid. Уникальный идентификатор блока команд. |
|
Идентификатор целевой группы
|
targetGroupId | True | string |
Формат — uuid. Уникальный идентификатор целевой группы. |
|
Технический идентификатор
|
technicalIdentifier | string |
Технический идентификатор. |
|
|
Ценность
|
value | string |
Ценность. |
|
|
Идентификатор расписания
|
scheduleId | string |
Идентификатор расписания. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ценность
|
value | string |
Ценность. |
Добавление задания блока команд для организации
Добавление задания блока команд. Проверка поставщика и действия основана на определенном блоке команд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
organizationId | True | string |
Формат — uuid. Уникальный идентификатор организации. |
|
Идентификатор блока команд
|
commandBlockId | True | string |
Формат — uuid. Уникальный идентификатор блока команд. |
|
Идентификатор целевой организации
|
targetOrganizationId | True | string |
Формат — uuid. Уникальный идентификатор целевой организации. |
|
Технический идентификатор
|
technicalIdentifier | string |
Технический идентификатор |
|
|
Ценность
|
value | string |
Ценность. |
|
|
Идентификатор расписания
|
scheduleId | string |
Идентификатор расписания. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ценность
|
value | string |
Ценность. |
Добавление задания блока команд для пользователя
Добавление задания блока команд. Проверка поставщика и действия основана на определенном блоке команд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
organizationId | True | string |
Формат — uuid. Уникальный идентификатор организации. |
|
Идентификатор блока команд
|
commandBlockId | True | string |
Формат — uuid. Уникальный идентификатор блока команд. |
|
Идентификатор целевого пользователя
|
targetUserId | True | string |
Формат — uuid. Уникальный идентификатор целевого пользователя. |
|
Технический идентификатор
|
technicalIdentifier | string |
Технический идентификатор. |
|
|
Ценность
|
value | string |
Ценность. |
|
|
Идентификатор расписания
|
scheduleId | string |
Идентификатор расписания. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ценность
|
value | string |
Ценность. |
Добавление участника в группу
Добавьте участника в группу Microsoft 365 или группу безопасности через свойство навигации членов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт группы.
|
microsoftObjectId | True | string |
Идентификатор объекта Майкрософт группы. |
|
Член
|
@odata.id | True | string |
URI каталога, пользователя, группы или объекта контакта организации, который необходимо добавить. |
Добавление участника в группу пользователей
Добавьте участника в группу пользователей, член должен принадлежать той же организации, что и группа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор группы пользователей Cloud User Hub.
|
userGroupId | True | string |
Идентификатор группы пользователей Cloud User Hub. |
|
Идентификатор пользователя Cloud User Hub.
|
userId | True | string |
Идентификатор пользователя Cloud User Hub. |
Назначение лицензии пользователю
Добавление или удаление лицензий для пользователя. Вы также можете включить и отключить определенные планы, связанные с лицензией.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт пользователя.
|
microsoftObjectId | True | string |
Идентификатор объекта Майкрософт пользователя. |
|
disabledPlans
|
disabledPlans | array of |
Отключенные планы. |
|
|
Идентификатор Sku
|
skuId | string |
Идентификатор Sku лицензии Майкрософт. |
|
|
Удалить лицензии
|
removeLicenses | array of |
Коллекция идентификаторов GUID, определяющих лицензии для удаления. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор объекта лицензии. |
|
Идентификатор Sku
|
value.skuId | string |
Идентификатор SKU Майкрософт. |
|
Номер части SKU
|
value.skuPartNumber | string |
Часть Microsoft Sku. |
|
servicePlans
|
value.servicePlans | array of object |
Планы обслуживания. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Идентификатор serviceplan. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Имя плана обслуживания. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Состояние подготовки. |
|
применяетсяК
|
value.servicePlans.appliesTo | string |
Применимо к. |
Обновление количества подписок
Обновите количество подписки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор партнера Cloud User Hub.
|
partnerId | True | string |
Идентификатор партнера Cloud User Hub. |
|
Идентификатор клиента Cloud User Hub.
|
customerId | True | string |
Идентификатор клиента Cloud User Hub. |
|
Идентификатор клиента Майкрософт.
|
tenantId | True | string |
Идентификатор клиента Майкрософт. |
|
Идентификатор подрипации.
|
subscriptionId | True | string |
Идентификатор подписки клиента. |
|
Количество
|
quantity | integer |
Количество подписки. |
Пароль изменения пользователя
Обновите профиль пароля пользователя, чтобы сбросить пароль.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт пользователя.
|
microsoftObjectId | True | string |
Идентификатор объекта Майкрософт пользователя. |
|
Принудительное изменение пароля при входе
|
forceChangePasswordNextSignIn | boolean |
Принудительно измените пароль при следующем входе. |
|
|
Пароль
|
password | string |
Новый пароль для задания. |
Перечисление блоков команд
Получите список доступных блоков команд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
элементы $top
|
$top | string |
Возвращает только первые $top элементы. |
|
|
элементы $skip
|
$skip | string |
Количество элементов, которые необходимо пропустить. |
|
|
Выбор фильтра
|
$select | string |
$select фильтр odata. |
|
|
Заказ по
|
$orderby | string |
Определяет, какие значения используются для упорядочивания коллекции записей. |
|
|
Filter
|
$filter | string |
Функция, которая должна иметь значение true для возвращаемой записи. |
|
|
Численность
|
$count | string |
Определяет, не включать количество элементов в коллекцию. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Количество OData
|
@odata.count | integer |
Количество OData. |
|
Следующая ссылка OData
|
@odata.nextLink | string |
Следующая ссылка OData. |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор. |
|
Технический идентификатор
|
value.technicalIdentifier | string |
Технический идентификатор. |
|
Тип
|
value.type | string |
Тип. |
|
Версия
|
value.version | integer |
Версия. |
|
Идентификатор категории
|
value.categoryId | string |
Идентификатор категории. |
|
Обязательное действие чтения
|
value.requiredReadAction | string |
Обязательное действие чтения. |
|
Обязательное действие записи
|
value.requiredWriteAction | string |
Обязательное действие записи. |
|
Обязательный поставщик
|
value.requiredProvider | string |
Обязательный поставщик. |
|
Идентификатор категории меню
|
value.menuCategory.id | string |
Идентификатор категории меню. |
|
Технический идентификатор
|
value.menuCategory.technicalIdentifier | string |
Технический идентификатор. |
|
Идентификатор родительской категории
|
value.parentCategory.id | string |
Идентификатор родительской категории. |
|
Технический идентификатор
|
value.parentCategory.technicalIdentifier | string |
Технический идентификатор. |
|
Идентификатор
|
value.category.id | string |
Идентификатор категории. |
|
Технический идентификатор
|
value.category.technicalIdentifier | string |
Технический идентификатор. |
Получение групп безопасности Azure AD
Получите список групп безопасности Azure AD всех организаций, которые вы авторизованы для просмотра.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of object |
Ценность. |
|
Создано
|
value.createdDateTime | string |
Создано. |
|
Отображаемое имя
|
value.displayName | string |
Отображаемое имя. |
|
groupTypes
|
value.groupTypes | array of string |
Типы групп. |
|
Идентификатор
|
value.id | string |
Идентификатор объекта Майкрософт группы. |
|
Включена безопасность
|
value.securityEnabled | boolean |
Указывает, включена ли группа безопасности. |
|
Mail
|
value.mail | string |
Адрес электронной почты группы. |
Получение групп пользователей Cloud User Hub
Получите список групп всех организаций, которые вы авторизованы для просмотра.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Фильтрация групп.
|
$filter | True | string |
Фильтрация по группам в организации. Use: organizationId in ('{organizationId}'). |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
@odata.count | integer |
Количество OData. |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор организации
|
value.organizationId | string |
Идентификатор организации Cloud User Hub. |
|
Имя
|
value.name | string |
Имя группы. |
|
Description
|
value.description | string |
Описание группы. |
|
Идентификатор
|
value.id | string |
Идентификатор группы. |
|
Создано
|
value.createdOn | string |
Создано. |
|
Когда изменено
|
value.modifiedOn | string |
Изменено. |
Получение заданий блока команд для всех авторизованных организаций
Получение заданий блока команд для блоков команд, которые вы авторизованы для просмотра.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
элементы $top
|
$top | string |
Возвращает только первые $top элементы. |
|
|
элементы $skip
|
$skip | string |
Количество элементов, которые необходимо пропустить. |
|
|
Выбор фильтра
|
$select | string |
$select фильтр odata. |
|
|
Заказ по
|
$orderby | string |
Определяет, какие значения используются для упорядочивания коллекции записей. |
|
|
Filter
|
$filter | string |
Функция, которая должна иметь значение true для возвращаемой записи. |
|
|
Численность
|
$count | string |
Определяет, следует ли включать в коллекцию количество элементов. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Количество OData
|
@odata.count | integer |
Количество OData. |
|
Следующая ссылка OData
|
@odata.nextLink | string |
Следующая ссылка OData |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор. |
|
Идентификатор блока команд
|
value.commandBlockId | string |
Идентификатор блока команд. |
|
Имя набора команд
|
value.commandSetName | string |
Имя набора команд. |
|
Идентификатор набора команд
|
value.commandSetId | string |
Идентификатор набора команд |
|
Идентификатор блока набора команд
|
value.commandSetBlockId | string |
Идентификатор блока набора команд. |
|
Идентификатор пользователя
|
value.userId | string |
Идентификатор пользователя. |
|
Основное имя пользователя
|
value.userUpn | string |
Имя участника-пользователя. |
|
Идентификатор группы
|
value.groupId | string |
Идентификатор группы. |
|
Имя группы
|
value.groupName | string |
Имя группы. |
|
Идентификатор организации
|
value.organizationId | string |
Идентификатор организации. |
|
Название организации
|
value.organizationName | string |
Имя организации. |
|
Имя пользователя субъекта
|
value.actorUserUpn | string |
Имя участника-субъекта субъекта-субъекта субъекта субъекта-субъекта. |
|
Идентификатор организации субъекта
|
value.actorOrganizationId | string |
Идентификатор организации субъекта. |
|
Имя организации субъекта
|
value.actorOrganizationName | string |
Имя организации субъекта. |
|
Состояние
|
value.status | string |
Состояние. |
|
Выполнено в
|
value.executedOn | string |
Выполнено. |
|
Технический идентификатор блока команд
|
value.commandBlockTechnicalIdentifier | string |
Технический идентификатор блока команд. |
|
Версия блока команд
|
value.commandBlockVersion | integer |
Версия блока команд. |
|
Запланированное выполнение
|
value.plannedExecution | string |
Запланированное выполнение. |
|
Идентификатор расписания
|
value.scheduleId | string |
Идентификатор расписания. |
|
Имя расписания
|
value.scheduleName | string |
Название расписания. |
Получение заданий блока команд определенной организации
Получение заданий блока команд для блоков команд, которые вы авторизованы для просмотра.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации.
|
organizationId | True | string |
Формат — uuid. Уникальный идентификатор организации. |
|
элементы $top
|
$top | string |
Возвращает только первые $top элементы. |
|
|
элементы $skip
|
$skip | string |
Количество элементов, которые необходимо пропустить. |
|
|
Выбор фильтра
|
$select | string |
$select фильтр odata. |
|
|
Заказ по
|
$orderby | string |
Определяет, какие значения используются для упорядочивания коллекции записей. |
|
|
Filter
|
$filter | string |
Функция, которая должна иметь значение true для возвращаемой записи. |
|
|
Численность
|
$count | string |
Определяет погоду или не включать количество элементов в коллекцию. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Количество OData
|
@odata.count | integer |
Количество OData. |
|
Следующая ссылка OData
|
@odata.nextLink | string |
Следующая ссылка OData. |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор. |
|
Идентификатор блока команд
|
value.commandBlockId | string |
Идентификатор блока команд. |
|
Имя набора команд
|
value.commandSetName | string |
Имя набора команд. |
|
Идентификатор набора команд
|
value.commandSetId | string |
Идентификатор набора команд. |
|
Идентификатор блока набора команд
|
value.commandSetBlockId | string |
Идентификатор блока набора команд. |
|
Идентификатор пользователя
|
value.userId | string |
Идентификатор пользователя. |
|
Имя участника-пользователя
|
value.userUpn | string |
Имя участника-пользователя. |
|
Идентификатор группы
|
value.groupId | string |
Идентификатор группы. |
|
Имя группы
|
value.groupName | string |
Имя группы. |
|
Идентификатор организации
|
value.organizationId | string |
Идентификатор организации. |
|
Название организации
|
value.organizationName | string |
Имя организации. |
|
Имя субъекта-пользователя субъекта-субъекта
|
value.actorUserUpn | string |
Имя участника-субъекта субъекта-субъекта субъекта субъекта-субъекта. |
|
Идентификатор организации субъекта
|
value.actorOrganizationId | string |
Идентификатор организации субъекта. |
|
Имя организации субъекта
|
value.actorOrganizationName | string |
Имя организации субъекта. |
|
Состояние
|
value.status | string |
Состояние. |
|
Выполнено в
|
value.executedOn | string |
Выполнено. |
|
Технический идентификатор блока команд
|
value.commandBlockTechnicalIdentifier | string |
Технический идентификатор блока команд. |
|
Версия блока команд
|
value.commandBlockVersion | integer |
Версия блока команд. |
|
Запланированное выполнение
|
value.plannedExecution | string |
Запланированное выполнение. |
|
Идентификатор расписания
|
value.scheduleId | string |
Идентификатор расписания. |
|
Имя расписания
|
value.scheduleName | string |
Название расписания. |
Получение категорий команд
Получение всех доступных категорий и подкатегорий.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
элементы $top
|
$top | string |
Возвращает только первые $top элементы. |
|
|
элементы $skip
|
$skip | string |
Количество элементов, которые необходимо пропустить. |
|
|
Выбор фильтра
|
$select | string |
$select фильтр odata. |
|
|
Заказ по
|
$orderby | string |
Определяет, какие значения используются для упорядочивания коллекции записей. |
|
|
Filter
|
$filter | string |
Функция, которая должна иметь значение true для возвращаемой записи. |
|
|
Численность
|
$count | string |
Определяет погоду или не включать количество элементов в коллекцию. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Количество OData
|
@odata.count | integer |
Количество OData. |
|
Следующая ссылка OData
|
@odata.nextLink | string |
Следующая ссылка OData. |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор. |
|
Технический идентификатор
|
value.technicalIdentifier | string |
Технический идентификатор. |
|
Идентификатор родительской категории
|
value.parentCategoryId | string |
Идентификатор родительской категории. |
Получение номеров SKU, подписанных организацией
Получите список коммерческих подписок, приобретенных организацией.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of object |
Ценность. |
|
Состояние возможности
|
value.capabilityStatus | string |
Состояние возможностей SKU Майкрософт. |
|
Потребляемые единицы
|
value.consumedUnits | integer |
Потребляемые единицы для этого номера SKU. |
|
Идентификатор
|
value.id | string |
Идентификатор объекта sku, подписанного на подписку. |
|
Идентификатор Sku
|
value.skuId | string |
Идентификатор Sku лицензии Майкрософт. |
|
Номер части SKU
|
value.skuPartNumber | string |
Номер SKU части лицензии Майкрософт. |
|
Применимо к
|
value.appliesTo | string |
Применяется к пользователю или организации. |
|
Включен
|
value.prepaidUnits.enabled | integer |
Включенные номера SKU с поддержкой подписки. |
|
Приостановлена
|
value.prepaidUnits.suspended | integer |
Приостановлено подписка skus. |
|
Предупреждение
|
value.prepaidUnits.warning | integer |
Подписка skus с предупреждением. |
|
servicePlans
|
value.servicePlans | array of object |
Планы обслуживания. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Идентификатор serviceplan. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Имя плана обслуживания. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Состояние подготовки. |
|
применяетсяК
|
value.servicePlans.appliesTo | string |
Применимо к. |
Получение организаций
Получите все организации, которые вы авторизованы для просмотра.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Количество OData
|
@odata.count | integer |
Количество OData. |
|
value
|
value | array of object |
Ценность. |
|
Имя
|
value.name | string |
Имя организации Azure AD. |
|
Microsoft tenantId
|
value.microsoftTenantId | string |
Идентификатор клиента Майкрософт организации. |
|
Создано
|
value.createdOn | string |
Создано. |
|
Когда изменено
|
value.modifiedOn | string |
Изменено. |
|
Идентификатор
|
value.id | string |
Идентификатор Облачного пользовательского центра. |
Получение подписок
Извлекает все подписки для клиента партнера по идентификатору клиента Active Directory.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор партнера Cloud User Hub.
|
partnerId | True | string |
Идентификатор партнера Cloud User Hub. |
|
Идентификатор клиента Cloud User Hub.
|
customerId | True | string |
Идентификатор клиента Cloud User Hub. |
|
Идентификатор клиента Майкрософт.
|
tenantId | True | string |
Идентификатор клиента Майкрософт. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Общее число
|
totalCount | integer |
Общее количество объектов подписки. |
|
items
|
items | array of object |
Элементы. |
|
Идентификатор
|
items.id | string |
Идентификатор подписки. |
|
Идентификатор права
|
items.entitlementId | string |
Идентификатор права подписки. |
|
Дружественное имя
|
items.friendlyName | string |
Понятное имя подписки. |
|
Количество
|
items.quantity | integer |
Количество подписки. |
|
Тип единицы
|
items.unitType | string |
Тип единицы подписки. |
|
Создано
|
items.creationDate | string |
Создано на дату подписки. |
|
Фактическая дата начала
|
items.effectiveStartDate | string |
Дата начала подписки. |
|
Дата окончания обязательства
|
items.commitmentEndDate | string |
Дата окончания обязательства подписки. |
|
Состояние
|
items.status | string |
Состояние подписки. |
|
Автоматическое продление
|
items.autoRenewEnabled | boolean |
Указывает, включена ли автоматическое продление подписки. |
|
Тип выставления счета
|
items.billingType | string |
Тип выставления счетов подписки. |
|
Тип контракта
|
items.contractType | string |
Тип контракта подписки. |
|
Ури
|
items.links.offer.uri | string |
Универсальный код ресурса (URI) подписки. |
|
Метод
|
items.links.offer.method | string |
Метод подписки. |
|
headers
|
items.links.offer.headers | array of |
Заголовки. |
|
Ури
|
items.links.self.uri | string |
Универсальный код ресурса (URI) подписки. |
|
Метод
|
items.links.self.method | string |
Метод подписки. |
|
headers
|
items.links.self.headers | array of |
Заголовки. |
|
Идентификатор заказа
|
items.orderId | string |
Идентификатор заказа подписки. |
|
Etag
|
items.attributes.etag | string |
Etag подписки. |
|
Тип объекта
|
items.attributes.objectType | string |
Тип объекта подписки. |
|
Тип объекта
|
attributes.objectType | string |
Тип объекта подписки. |
Получение пользователей
Получение списка объектов пользователя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Фильтрация пользователей.
|
$filter | True | string |
Фильтрация пользователей в организации. Use: organizationId in ('{organizationId}'). |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Количество OData
|
@odata.count | integer |
Количество OData. |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор организации
|
value.organizationId | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт
|
value.microsoftObjectIdentifier | string |
Идентификатор объекта Майкрософт пользователя. |
|
Основное имя пользователя
|
value.upn | string |
Имя участника-пользователя пользователя. |
|
Имя (первое имя)
|
value.firstName | string |
Имя пользователя. |
|
Фамилия
|
value.lastName | string |
Фамилия пользователя. |
|
Показать имя
|
value.displayName | string |
Отображаемое имя пользователя. |
|
Language
|
value.language | string |
Язык пользователя. |
|
Место использования
|
value.usageLocation | string |
Расположение использования пользователя. |
|
Идентификатор
|
value.id | string |
Идентификатор облачного пользовательского центра пользователя. |
|
Создано
|
value.createdOn | string |
Создано вкл. |
|
Когда изменено
|
value.modifiedOn | string |
Изменено. |
Получение сведений о блоке команд
Получение сведений о блоке команд. Проверка поставщика и действия зависят от конкретного блока команд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор блока команд
|
commandBlockId | True | string |
Формат — uuid. Уникальный идентификатор блока команд. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
Версия
|
version | integer |
Версия. |
|
Идентификатор категории
|
categoryId | string |
Идентификатор категории. |
|
Технический идентификатор
|
technicalIdentifier | string |
Технический идентификатор. |
|
Обязательное действие чтения
|
requiredReadAction | string |
Обязательное действие чтения. |
|
Обязательное действие записи
|
requiredWriteAction | string |
Обязательное действие записи. |
|
Обязательный поставщик
|
requiredProvider | string |
Обязательный поставщик. |
|
Тип
|
type | string |
Тип. |
|
Идентификатор
|
category.id | string |
Идентификатор. |
|
Технический идентификатор
|
category.technicalIdentifier | string |
Технический идентификатор. |
|
Идентификатор
|
parentCategory.id | string |
Идентификатор. |
|
Технический идентификатор
|
parentCategory.technicalIdentifier | string |
Технический идентификатор. |
|
Идентификатор
|
menuCategory.id | string |
Идентификатор. |
|
Технический идентификатор
|
menuCategory.technicalIdentifier | string |
Технический идентификатор. |
|
Выбор нескольких элементов
|
commandInput.multiSelection | string |
Выбор нескольких элементов. |
|
LayoutGroups
|
commandInput.layoutGroups | array of object |
Группы макетов. |
|
Технический идентификатор
|
commandInput.layoutGroups.technicalIdentifier | string |
Технический идентификатор. |
|
LayoutGroupFormats
|
commandInput.layoutGroups.layoutGroupFormats | array of object |
Форматы групп макетов. |
|
type
|
commandInput.layoutGroups.layoutGroupFormats.type | string |
Тип. |
|
property
|
commandInput.layoutGroups.layoutGroupFormats.property | string |
Свойство. |
|
properties
|
commandInput.layoutGroups.layoutGroupFormats.properties | array of |
Свойства. |
|
parameters
|
commandInput.parameters | array of object |
Параметры. |
|
Значение по умолчанию
|
commandInput.parameters.defaultValue | string |
Значение по умолчанию. |
|
Технический идентификатор
|
commandInput.parameters.technicalIdentifier | string |
Технический идентификатор. |
|
Schema
|
commandInput.parameters.schema | string |
Схема. |
|
Конфиденциальные
|
commandInput.parameters.sensitive | boolean |
Чувствительный. |
|
Обязательно
|
commandInput.parameters.required | boolean |
Обязательное. |
|
Ценность
|
commandInput.parameters.value | string |
Ценность. |
|
Набор команд
|
commandInput.parameters.placeholderEnabled.commandSet | boolean |
Набор команд. |
|
Блок команд
|
commandInput.parameters.placeholderEnabled.commandBlock | boolean |
Блок команд. |
|
linkedCommandBlocks
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Связанные блоки команд. |
|
technicalIdentifier
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Технический идентификатор. |
|
version
|
commandInput.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Версия. |
|
LayoutGroups
|
commandOutput.layoutGroups | array of object |
Группы макетов. |
|
Технический идентификатор
|
commandOutput.layoutGroups.technicalIdentifier | string |
Технический идентификатор. |
|
LayoutGroupFormats
|
commandOutput.layoutGroups.layoutGroupFormats | array of object |
Форматы групп макетов. |
|
type
|
commandOutput.layoutGroups.layoutGroupFormats.type | string |
Тип. |
|
property
|
commandOutput.layoutGroups.layoutGroupFormats.property | string |
Свойство. |
|
properties
|
commandOutput.layoutGroups.layoutGroupFormats.properties | array of |
Свойства. |
|
parameters
|
commandOutput.parameters | array of object |
Параметры. |
|
Example
|
commandOutput.parameters.example | string |
Пример. |
|
Технический идентификатор
|
commandOutput.parameters.technicalIdentifier | string |
Технический идентификатор. |
|
Schema
|
commandOutput.parameters.schema | string |
Схема. |
|
Конфиденциальные
|
commandOutput.parameters.sensitive | boolean |
Чувствительный. |
|
Обязательно
|
commandOutput.parameters.required | boolean |
Обязательное. |
|
Ценность
|
commandOutput.parameters.value | string |
Ценность. |
|
Набор команд
|
commandOutput.parameters.placeholderEnabled.commandSet | boolean |
Набор команд. |
|
Блок команд
|
commandOutput.parameters.placeholderEnabled.commandBlock | boolean |
Блок commmand. |
Получение сведений о лицензии пользователя
Получение списка объектов сведений о лицензии для корпоративных пользователей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт пользователя.
|
microsoftObjectId | True | string |
Идентификатор объекта Майкрософт пользователя. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор лицензии пользователя. |
|
Идентификатор Sku
|
value.skuId | string |
Идентификатор Sku лицензии Майкрософт. |
|
Номер части SKU
|
value.skuPartNumber | string |
Номер SKU части лицензии Майкрософт. |
|
servicePlans
|
value.servicePlans | array of object |
Планы обслуживания. |
|
servicePlanId
|
value.servicePlans.servicePlanId | string |
Идентификатор serviceplan. |
|
servicePlanName
|
value.servicePlans.servicePlanName | string |
Имя плана обслуживания. |
|
provisioningStatus
|
value.servicePlans.provisioningStatus | string |
Состояние подготовки. |
|
применяетсяК
|
value.servicePlans.appliesTo | string |
Применимо к. |
Получение сведений о пользователе
Получение пользователя по идентификатору объекта Майкрософт.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт пользователя.
|
microsoftObjectId | True | string |
Идентификатор объекта Майкрософт пользователя. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Учетная запись включена
|
accountEnabled | boolean |
Включена учетная запись true или false. |
|
Идентификатор сотрудника
|
employeeId | string |
Идентификатор сотрудника пользователя. |
|
Показать имя
|
displayName | string |
Отображаемое имя пользователя. |
|
Личное имя
|
givenName | string |
Заданное имя пользователя. |
|
Surname
|
surname | string |
Фамилия пользователя. |
|
Основное имя пользователя
|
userPrincipalName | string |
Имя участника-пользователя пользователя. |
|
Название задания
|
jobTitle | string |
Название задания пользователя. |
|
Отдел
|
department | string |
Отдел пользователя. |
|
Название компании
|
companyName | string |
Имя компании пользователя. |
|
Расположение использования
|
usageLocation | string |
Расположение использования пользователя. |
|
Адрес улицы
|
streetAddress | string |
Адрес улицы пользователя. |
|
Город
|
city | string |
Город пользователя. |
|
Государство
|
state | string |
Состояние пользователя. |
|
Почтовый индекс
|
postalCode | string |
Почтовый индекс пользователя. |
|
Страна
|
country | string |
Страна пользователя. |
Получение сведений об одном задании пользователя
Получение сведений об одном задании пользователя, поставщике и проверке действий зависит от конкретного блока команд.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации
|
organizationId | True | string |
Формат — uuid. Уникальный идентификатор организации. |
|
Идентификатор блока команд
|
commandBlockId | True | string |
Формат — uuid. Уникальный идентификатор блока команд. |
|
Идентификатор задания
|
jobId | True | string |
Формат — uuid. Уникальный идентификатор задания. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор. |
|
Идентификатор блока команд
|
commandBlockId | string |
Идентификатор блока команд. |
|
Имя набора команд
|
commandSetName | string |
Имя набора команд. |
|
Идентификатор набора команд
|
commandSetId | string |
Идентификатор набора команд. |
|
Идентификатор блока набора команд
|
commandSetBlockId | string |
Идентификатор блока набора команд. |
|
Идентификатор пользователя
|
userId | string |
Идентификатор пользователя. |
|
Имя участника-пользователя
|
userUpn | string |
Имя участника-пользователя пользователя. |
|
Идентификатор группы
|
groupId | string |
Идентификатор группы. |
|
Имя группы
|
groupName | string |
Имя группы. |
|
Идентификатор организации
|
organizationId | string |
Идентификатор организации. |
|
Название организации
|
organizationName | string |
Имя организации. |
|
Upn субъекта
|
actorUserUpn | string |
Имя участника-субъекта субъекта-субъекта субъекта субъекта-субъекта. |
|
Идентификатор организации субъекта
|
actorOrganizationId | string |
Идентификатор организации субъекта. |
|
Имя организации субъекта
|
actorOrganizationName | string |
Имя организации субъекта. |
|
Состояние
|
status | string |
Состояние. |
|
Выполнено в
|
executedOn | string |
Выполнено. |
|
Технический идентификатор блока команд
|
commandBlockTechnicalIdentifier | string |
Технический идентификатор блока команд. |
|
Версия блока команд
|
commandBlockVersion | integer |
Версия блока команд. |
|
LayoutGroups
|
output.body.layoutGroups | array of object |
Форматы групп макетов. |
|
LayoutGroupFormats
|
output.body.layoutGroups.layoutGroupFormats | array of object |
Форматы групп макетов. |
|
type
|
output.body.layoutGroups.layoutGroupFormats.type | string |
Тип. |
|
property
|
output.body.layoutGroups.layoutGroupFormats.property | string |
Свойство. |
|
properties
|
output.body.layoutGroups.layoutGroupFormats.properties | array of string |
Свойства. |
|
parameters
|
output.body.parameters | array of object |
Параметры. |
|
Технический идентификатор
|
output.body.parameters.technicalIdentifier | string |
Технический идентификатор. |
|
Ценность
|
output.body.parameters.value | string |
Ценность. |
|
Schema
|
output.body.parameters.schema | string |
Схема. |
|
Набор команд
|
output.body.parameters.placeholderEnabled.commandSet | boolean |
Набор команд. |
|
Блок команд
|
output.body.parameters.placeholderEnabled.commandBlock | boolean |
Блок команд. |
|
Код ошибки
|
output.errorCode | string |
Код ошибки. |
|
Success
|
output.isSuccess | boolean |
Успешный. |
|
LayoutGroups
|
input.layoutGroups | array of object |
Группы макетов. |
|
LayoutGroupFormats
|
input.layoutGroups.layoutGroupFormats | array of object |
Форматы групп макетов. |
|
type
|
input.layoutGroups.layoutGroupFormats.type | string |
Тип. |
|
property
|
input.layoutGroups.layoutGroupFormats.property | string |
Свойство. |
|
properties
|
input.layoutGroups.layoutGroupFormats.properties | array of string |
Свойства. |
|
Несколько организаций
|
input.multiSelection.multipleOrganizations | boolean |
Несколько организаций. |
|
Несколько пользователей
|
input.multiSelection.multipleUsers | boolean |
Несколько пользователей. |
|
parameters
|
input.parameters | array of object |
Параметры. |
|
Технический идентификатор
|
input.parameters.technicalIdentifier | string |
Технический идентификатор. |
|
Ценность
|
input.parameters.value | string |
Ценность. |
|
Значение по умолчанию
|
input.parameters.defaultValue | string |
Значение по умолчанию. |
|
Тип
|
input.parameters.schema.type | string |
Тип. |
|
Формат
|
input.parameters.schema.format | string |
Формат. |
|
Рисунок
|
input.parameters.schema.pattern | string |
Рисунок. |
|
Минимальная длина
|
input.parameters.schema.minLength | string |
Минимальная длина. |
|
Набор команд
|
input.parameters.placeholderEnabled.commandSet | boolean |
Набор команд. |
|
Блок команд
|
input.parameters.placeholderEnabled.commandBlock | boolean |
Блок команд. |
|
linkedCommandBlocks
|
input.parameters.placeholderEnabled.linkedCommandBlocks | array of object |
Связанные блоки команд. |
|
technicalIdentifier
|
input.parameters.placeholderEnabled.linkedCommandBlocks.technicalIdentifier | string |
Технический идентификатор. |
|
version
|
input.parameters.placeholderEnabled.linkedCommandBlocks.version | integer |
Версия. |
Получение списка участников группы пользователей Cloud User Hub
Получите список членов группы пользователей определенной группы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор облачного пользовательского центра группы.
|
userGroupId | True | string |
Идентификатор облачного пользовательского центра группы. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
@odata.count | integer |
Количество OData. |
|
value
|
value | array of object |
Ценность. |
|
Имя
|
value.name | string |
Имя. |
|
Основное имя пользователя
|
value.upn | string |
Имя участника-пользователя группы. |
|
Идентификатор
|
value.id | string |
Идентификатор объекта-члена группы. |
|
Идентификатор группы
|
value.groupId | string |
Идентификатор облачного пользовательского центра группы. |
|
Создано
|
value.createdOn | string |
Создано. |
|
Когда изменено
|
value.modifiedOn | string |
Изменено. |
Получение статистики заданий блока команд для всех авторизованных организаций
Получите статистику по заданиям блока команд для блоков команд, которые вы авторизованы для просмотра.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор категории
|
categoryId | True | string |
Формат — uuid. Уникальный идентификатор категории. |
|
Выбор фильтра
|
$select | string |
$select фильтр odata. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Тип
|
type | string |
Тип. |
|
Категория
|
category | string |
Категория. |
|
Период
|
period | string |
Период. |
|
Завершено
|
completed | integer |
Завершённый. |
|
В очереди
|
queued | integer |
Очереди. |
|
Неудача
|
failed | integer |
Неудавшийся. |
Получение языковых стандартов
Получение языковых стандартов.
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Численность
|
@odata.count | integer |
Количество OData. |
|
OData nextLink
|
@odata.nextLink | string |
Следующая ссылка OData. |
|
value
|
value | array of object |
Ценность. |
|
Идентификатор
|
value.id | string |
Идентификатор языкового стандарта. |
|
Код языкового стандарта
|
value.localeCode | string |
Коды языка ISO-639. |
|
Код страны
|
value.countryCode | string |
Коды стран ISO-3166. |
|
Имя страны
|
value.countryName | string |
Имя страны. |
Создание группы Azure AD
Создайте группу Azure AD.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Description
|
description | string |
Описание группы. |
|
|
Показать имя
|
displayName | string |
Отображаемое имя группы. |
|
|
groupTypes
|
groupTypes | array of string |
Типы групп. |
|
|
Почта включена
|
mailEnabled | boolean |
Указывает, включена ли группа. |
|
|
Прозвище почты
|
mailNickname | string |
Почтовое прозвище группы. |
|
|
Включена безопасность
|
securityEnabled | boolean |
Указывает, включена ли группа безопасности. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор группы. |
|
Удалено
|
deletedDateTime | string |
Удалено. |
|
Classification
|
classification | string |
Классификация группы. |
|
Создано
|
createdDateTime | string |
Создано. |
|
creationOptions
|
creationOptions | array of string |
Параметры создания. |
|
Description
|
description | string |
Description. |
|
Показать имя
|
displayName | string |
Отображаемое имя. |
|
groupTypes
|
groupTypes | array of string |
groupTypes |
|
Mail
|
string |
Адрес электронной почты группы. |
|
|
Почта включена
|
mailEnabled | boolean |
Указывает, что группа включена почта. |
|
Прозвище почты
|
mailNickname | string |
Почтовое прозвище группы. |
|
Локальная последняя синхронизация
|
onPremisesLastSyncDateTime | string |
Указывает, когда группа была синхронизирована с локальной. |
|
Локальный идентификатор безопасности
|
onPremisesSecurityIdentifier | string |
Локальный идентификатор безопасности группы. |
|
Включена локальная синхронизация
|
onPremisesSyncEnabled | string |
Указывает, включена ли локальная синхронизация. |
|
Предпочтительное расположение данных
|
preferredDataLocation | string |
Предпочтительное расположение данных группы. |
|
прокси-адреса
|
proxyAddresses | array of string |
Адреса прокси-сервера. |
|
Обновленный
|
renewedDateTime | string |
Продленное время даты группы. |
|
resourceBehaviorOptions
|
resourceBehaviorOptions | array of string |
Параметры поведения ресурсов. |
|
resourceProvisioningOptions
|
resourceProvisioningOptions | array of string |
Параметры проверки ресурсов. |
|
Включена безопасность
|
securityEnabled | boolean |
Указывает, включена ли группа безопасности. |
|
Visbility
|
visibility | string |
Видимость группы. |
|
onPremisesProvisioningErrors
|
onPremisesProvisioningErrors | array of string |
Ошибки локальной подготовки. |
Создание пользователя
Текст запроса содержит пользователя для создания. Как минимум, необходимо указать необходимые свойства для пользователя. При необходимости можно указать любые другие доступные для записи свойства.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Учетная запись включена
|
accountEnabled | boolean |
Включена учетная запись true или false. |
|
|
Показать имя
|
displayName | string |
Отображаемое имя пользователя. |
|
|
Прозвище почты
|
mailNickname | string |
Псевдоним почты пользователя. |
|
|
Основное имя пользователя
|
userPrincipalName | string |
Имя участника-пользователя пользователя. |
|
|
Принудительное изменение пароля следующего входа
|
forceChangePasswordNextSignIn | boolean |
Принудительно измените пароль при следующем входе. |
|
|
Пароль
|
password | string |
Новый пароль для пользователя. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Контекст OData
|
@odata.context | string |
Контекст OData. |
|
Идентификатор
|
id | string |
Идентификатор облачного пользовательского центра. |
|
businessPhones
|
businessPhones | array of string |
Бизнес-телефоны пользователя. |
|
Показать имя
|
displayName | string |
Отображаемое имя пользователя. |
|
Личное имя
|
givenName | string |
Имя. |
|
Название задания
|
jobTitle | string |
Название задания пользователя. |
|
Mail
|
string |
Адрес электронной почты пользователя. |
|
|
Мобильный телефон
|
mobilePhone | string |
Номер мобильного телефона пользователя. |
|
Расположение Office
|
officeLocation | string |
Расположение пользователя в Office. |
|
Предпочитаемый язык
|
preferredLanguage | string |
Предпочтительный язык, настроенный в Azure AD. |
|
Surname
|
surname | string |
Фамилия пользователя. |
|
Основное имя пользователя
|
userPrincipalName | string |
Имя участника-пользователя пользователя. |
Удаление группы пользователей Cloud User Hub
Удаление группы пользователей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор Облачного пользовательского центра для группы пользователей.
|
userGroupId | True | string |
Идентификатор Облачного пользовательского центра для группы пользователей. |
Удаление пользователя
Удаление пользователя. При удалении ресурсы пользователей перемещаются во временный контейнер и могут быть восстановлены в течение 30 дней. По истечении этого периода они удаляются без возможности восстановления.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт пользователя.
|
microsoftObjectId | True | string |
Идентификатор объекта Майкрософт пользователя. |
Удаление члена
Удалите члена из группы с помощью свойства навигации членов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор объекта Майкрософт группы.
|
groupMicrosoftObjectId | True | string |
Идентификатор объекта Майкрософт группы. |
|
Идентификатор объекта Майкрософт пользователя.
|
userMicrosoftObjectId | True | string |
Идентификатор объекта Майкрософт пользователя. |
Удаление члена из группы пользователей
Удалите участника в группу пользователей.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор организации Cloud User Hub.
|
organizationId | True | string |
Идентификатор организации Cloud User Hub. |
|
Идентификатор группы пользователей Cloud User Hub.
|
userGroupId | True | string |
Идентификатор группы пользователей Cloud User Hub. |
|
Идентификатор пользователя Cloud User Hub.
|
userId | True | string |
Идентификатор пользователя Cloud User Hub. |