Можно настроить внешние приложения для использования основных функциональных возможностей Workspace ONE UEM путем интеграции API-интерфейсов REST с инфраструктурой UEM и тем самым облегчить процесс подключения. Можно также выбрать ближайший к центру обработки данных URL-адрес токена OAuth для аутентификации вызовов API-интерфейса.
Начало работы с REST API
Используя упрощенную архитектуру программного обеспечения REST, API-интерфейсы REST в Workspace ONE UEM в настоящее время поддерживают множество функций, включая организационную группу, администрирование консоли, мобильное приложение, мобильное устройство, электронную почту, пользователя для регистрации, профиль, смарт-группу и управление группами пользователей.
Использование API-интерфейсов на основе REST обеспечивает ряд преимуществ для компаний, что позволяет избавиться от затрат средств и времени на разработку приложений собственными силами. API-интерфейсы REST в Workspace ONE UEM полностью готовы к интеграции с корпоративными серверами, программами и процессами. Кроме того, API-интерфейсы REST в Workspace ONE UEM более эффективны, могут работать бесперебойно и легко настраиваются в соответствии с фирменной символикой компаний. Эти API-интерфейсы предназначены для разработчиков приложений, и в данном руководстве содержится информация о проектировании и архитектуре библиотеки API для облегчения разработки и интеграции с Workspace ONE UEM.
Доступ к документации по API-интерфейсам
См. подробную документацию по API-интерфейсам на странице справки по API-интерфейсам в Workspace ONE UEM.
Для этого в средах SaaS необходимо заменить «cn» в URL-адресе на «as», а затем добавить /api/help
после .com.
https://cn4855.awmdm.com—
https://as4855.awmdm.com/api/help
URL-адреса центров обработки данных и маркеров для поддержки OAuth 2.0
Workspace ONE UEM обеспечивает поддержку отраслевого стандартного протокола Oauth 2.0 для безопасной аутентификации и авторизации для вызовов REST API.
Служба маркеров Workspace ONE — это служба поставщика маркеров для проверки подлинности OAuth, которая в настоящее время поддерживается только в средах SaaS. URL-адреса маркеров зависят от региона.
Регион | Расположение центра обработки данных SaaS Workspace ONE UEM | URL-адрес маркера |
---|---|---|
Огайо (США) | Все среды UAT | https://uat.uemauth.vmwservices.com/connect/token |
Вирджиния (США) | Соединенные Штаты Америки | https://na.uemauth.vmwservices.com/connect/token |
Вирджиния (США) | Канада | https://na.uemauth.vmwservices.com/connect/token |
Франкфурт (Германия) | Великобритания | https://emea.uemauth.vmwservices.com/connect/token |
Франкфурт (Германия) | Германия | https://emea.uemauth.vmwservices.com/connect/token |
Токио (Япония) | Индия | https://apac.uemauth.vmwservices.com/connect/token |
Токио (Япония) | Япония | https://apac.uemauth.vmwservices.com/connect/token |
Токио (Япония) | Сингапур | https://apac.uemauth.vmwservices.com/connect/token |
Токио (Япония) | Австралия | https://apac.uemauth.vmwservices.com/connect/token |
Токио (Япония) | Гонконг | https://apac.uemauth.vmwservices.com/connect/token |
Создание клиента OAuth для использования с командами API-интерфейса (SaaS)
Можно создать клиент OAuth для использования команд API-интерфейса, который поддерживается только в средах SaaS. Создайте клиент OAuth для своей среды SaaS, выполнив следующие действия.
- Выберите .
- Введите
OAuth
в текстовом поле поиска «Введите имя или категорию». - Выберите вариант Управление клиентами OAuth, который отображается в результатах. Отобразится экран Управление клиентами OAuth.
- Выберите клавишу Добавить.
- Заполните поля Имя, Описание, Организационная группа и Роль.
Примечание: Подробнее об определенных разрешениях REST API для выбранной роли см. в разделе Создание роли, которая позволяет использовать API-интерфейсы REST.
- Убедитесь, что для параметра Статус задано значение Включено.
- Нажмите Сохранить.
- ВАЖНО! Скопируйте ID клиента и Секрет клиента в буфер обмена и сохраните их, прежде чем закрыть экран. Щелкните значок буфера обмена (
), чтобы отправитьСекрет клиента в буфер обмена.
После нажатия Закрыть невозможно будет вернуться сюда, чтобы извлечь эти сведения.
- Используйте ID клиента, секрет клиента и URL-адрес маркера для создания маркера доступа в следующем формате:
Вызов API: POST {URL-адрес маркера, зависящий от региона, из раздела выше}
Ключ Значение grant_type client_credentials client_id {CLIENT ID, созданный в UEM Console} client_secret {CLIENT SECRET, созданный в UEM Console} - Используйте возвращенный маркер доступа для авторизации будущих запросов API-интерфейса к API-серверам Workspace ONE UEM. Маркер доступа должен быть указан в заголовках запроса в следующем формате.
Вызов API: {UEM API}
Ключ Значение Authorization [Маркер доступа}
Создание роли, которая позволяет использовать API-интерфейсы REST
Каждый планируемый вызов API-интерфейса имеет соответствующий ресурс (или разрешение), который необходимо включить в роль, назначенную клиенту OAuth. Таким образом, разрешения на добавление в назначенную роль, содержат типы вызовов API-интерфейсов, которые вы выполняете.
Категория | Имя | Описание | Только чтение/Редактирование |
---|---|---|---|
REST > Администраторы | API REST Система - группы | Информация о доступе к организационной группе | Редактировать |
API REST Система - админ | Доступ к админ информации | Редактировать | |
API REST Система - пользователи | Информация о доступе к группе пользователей | Редактировать | |
Писать админ. REST API | Разрешает доступ ко всем API-интерфейсам записи/обновления в коллекции «Пользователи-администраторы» | Редактировать | |
Выполнить админ. REST API | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Пользователи-администраторы» | Редактировать | |
Удалить админ. REST API | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Пользователи-администраторы» | Редактировать | |
Читать админ. REST API | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Пользователи-администраторы» | Только для чтения | |
REST > Приложения | REST API MAM Blob | Отправить или загрузить контент | Редактировать |
Прилож. Rest API MAM Apps | Доступ к управляемым приложениям | Редактировать | |
Писать прилож. REST API | Разрешает доступ ко всем API-интерфейсам записи/обновления в коллекции «Приложения» | Редактировать | |
Выполнить прилож. REST API | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Приложения» | Редактировать | |
Удалить прилож. REST API | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Приложения» | Редактировать | |
Читать прилож. REST API | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Приложения» | Только для чтения | |
REST > Политика соответствия | Удаление политики соответствия REST API | Разрешает доступ ко всем API-интерфейсам удаления в коллекции политик соответствия | Редактировать |
Выполнение политики соответствия REST API | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции политик соответствия | Редактировать | |
Запись политики соответствия REST API | Разрешает доступ ко всем API-интерфейсам записи в коллекции политик соответствия | Редактировать | |
Чтение политики соответствия REST API | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции политик соответствия | Только для чтения | |
REST > Настраиваемые атрибуты | Выполнить настраиваемые атрибуты REST API | Открывает доступ ко всем API выполнения в коллекции настраиваемых атрибутов | Редактировать |
Записать настраиваемые атрибуты REST API | Открывает доступ ко всем API записи в коллекции настраиваемых атрибутов | Редактировать | |
Удалить настраиваемые атрибуты REST API | Открывает доступ ко всем API удаления в коллекции настраиваемых атрибутов | Редактировать | |
Читать настраиваемые атрибуты REST API | Открывает доступ ко всем API только для чтения в коллекции настраиваемых атрибутов | Только для чтения | |
REST > Устройства | Смарт-группы REST API MDM | Доступ к сведениям о смарт-группе | Редактировать |
REST API MDM группы пользователей | Доступ к группам пользователей | Редактировать | |
Профили REST API MDM | Отправлять команды блокировки и разблокировки | Редактировать | |
REST API MDM устройства | Отправлять команды блокировки или разблокировки | Редактировать | |
Записать REST API BLOBS | Открывает доступ ко всем API только для записи/обновления в коллекции BLOBS | Редактировать | |
Выполнить REST API BLOBS | Открывает доступ ко всем API только для выполнения в коллекции BLOBS | Редактировать | |
Удалить REST API BLOBS | Открывает доступ ко всем API только для удаления в коллекции BLOBS | Редактировать | |
Записать устройства по REST API | Разрешает доступ ко всем API-интерфейсам записи/обновления в коллекции «Устройства» | Редактировать | |
Выполнить REST API устройства | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Устройства» | Редактировать | |
Удалить устройства по REST API | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Устройства» | Редактировать | |
Устройства REST API, дополнительно | Разрешает доступ ко всем расширенным API-интерфейсам в коллекции «Устройства» | Редактировать | |
Читать REST API BLOBS | Открывает доступ ко всем API только для чтения в коллекции BLOBS | Только для чтения | |
Читать REST API устройства | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Устройства» | Только для чтения | |
REST > Интеграция предприятий REST | Чтение интеграции предприятий REST API | Открывает доступ ко всем API только для чтения в разделе Интеграция предприятий | Только для чтения |
REST > Группы | Писать группы API REST | Разрешает доступ ко всем API-интерфейсам записи/обновления в коллекции «Организационные группы» | Редактировать |
Выполнить группы API REST | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Организационные группы» | Редактировать | |
Удалять группы API REST | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Организационные группы» | Редактировать | |
REST API Смарт-группы: писать | Разрешает доступ ко всем API-интерфейсам записи в коллекции «Смарт-группы» | Редактировать | |
Выполнить смарт-группы REST API | Разрешает доступ ко всем API-интерфейсам выполнения в коллекциях «Смарт-группы» | Редактировать | |
Удалить смарт-группы REST API | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Смарт-группы» | Редактировать | |
REST API группы пользователей - запись | Разрешает доступ ко всем API-интерфейсам для записи/обновления в группах пользователей | Редактировать | |
REST API группы пользователей - выполнить | Разрешает доступ ко всем API-интерфейсам выполнения в группах пользователей | Редактировать | |
REST API группы пользователей - удалить | Разрешает доступ ко всем API-интерфейсам удаления в группах пользователей | Редактировать | |
REST API записи корзины | REST API для сохранения и изменения данных корзины | Редактировать | |
REST API удаления корзины | REST API для удаления данных корзины | Редактировать | |
REST API записи Apple School Manager | REST API для инициирования синхронизации Apple School Manager | Редактировать | |
REST API сопоставления Apple School Manager | REST API для сопоставления пользователя регистрации с участником Apple School Manager | Редактировать | |
REST API сохранения назначений классов | Вызов REST API для сохранения назначений класса | Редактировать | |
REST API записи класса | API REST для сохранения и изменения данных класса | Редактировать | |
REST API удаления класса | REST API для удаления данных класса | Редактировать | |
REST API записи настроек Education | REST API для сохранения и изменения настроек образования | Редактировать | |
Чтение настроек REST API Education | API REST для просмотра настроек образования | Редактировать | |
Читать группы API REST | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Организационные группы» | Только для чтения | |
REST API Смарт-группы: читать | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Смарт-группы» | Только для чтения | |
REST API группы пользователей - чтение | Разрешает доступ ко всем API-интерфейсам только для чтения в группах пользователей | Только для чтения | |
REST API чтения синхронизации Apple School Manager | REST API для проверки статуса синхронизации Apple School Manager | Только для чтения | |
REST API чтения приложений для устройства | REST API для получения списка приложений, подходящих устройству | Только для чтения | |
REST API чтения класса | REST API для просмотра данных класса | Только для чтения | |
REST > Продукты | API Rest - выполнить продукты | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Продукты» | Редактировать |
API REST продукты- записать | Разрешает доступ ко всем API-интерфейсам записи в коллекции «Продукты» | Редактировать | |
Rest API удалить продукты | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Продукты» | Редактировать | |
API Rest - читать продукты | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Продукты» | Только для чтения | |
REST > Профили | Доступ к записи политики обновлений | Разрешает доступ ко всем API-интерфейсам WRITE в коллекции политик обновлений | Редактировать |
Доступ к выполнению политики обновлений | Разрешает доступ ко всем API-интерфейсам EXECUTE в коллекции политик обновлений | Редактировать | |
Доступ к удалению политики обновлений | Разрешает доступ ко всем API-интерфейсам DELETE в коллекции политик обновлений | Редактировать | |
Запись профилей API REST | Разрешает доступ ко всем API-интерфейсам записи в коллекции «Профили» | Редактировать | |
Выполнение профилей API REST | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Профили» | Редактировать | |
Удалить профили API REST | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Профили» | Редактировать | |
Доступ к чтению политики обновлений | Разрешает доступ ко всем API-интерфейсам READ Only в коллекции политик обновлений | Только для чтения | |
Чтение профилей API REST | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Профили» | Только для чтения | |
REST > Пользователи | REST API пользователи - запись | Разрешает доступ ко всем API-интерфейсам записи/обновления в коллекции «Зарегистрированные пользователи» | Редактировать |
REST API пользователи - выполнить | Разрешает доступ ко всем API-интерфейсам выполнения в коллекции «Зарегистрированные пользователи» | Редактировать | |
REST API пользователи - удалить | Разрешает доступ ко всем API-интерфейсам удаления в коллекции «Зарегистрированные пользователи» | Редактировать | |
Маркеры пользователей Rest API: читать | Открывает доступ к пользовательским маркерам регистрации для API в коллекции пользователей регистрации | Только для чтения | |
REST API пользователи - чтение | Разрешает доступ ко всем API-интерфейсам только для чтения в коллекции «Зарегистрированные пользователи» | Только для чтения |