将 UEM 功能与 REST API 结合使用

通过将 REST API 与 UEM 基础架构集成并建立连接，可以将外部应用程序配置为使用 Workspace ONE UEM 的核心产品功能。还可以选择使用距离您的数据中心最近的 OAuth 令牌 URL 来对 API 调用进行身份验证。

REST API 入门

使用简化的 REST 软件架构，Workspace ONE UEM REST API 当前支持多种功能，包括组织组、控制台管理、移动应用程序、移动设备、电子邮件、注册用户、配置文件、智能组和用户组管理。

使用基于 REST 的 API 可为企业带来多种好处，包括减少在内部开发应用程序所需的成本和时间。Workspace ONE UEM REST API 完全能够并已准备好与企业服务器、程序和进程集成。Workspace ONE UEM REST API 更加高效，可以顺畅运行，并且可以轻松使用企业的品牌标识进行自定义。这些 API 适用于应用程序开发人员。本指南有助于了解 API 库的设计和架构，并促进自定义开发以及与 Workspace ONE UEM 集成。

访问 API 文档

通过导航到 Workspace ONE UEM API 帮助页面，查看详细的 API 文档。

1. 以管理员身份登录 Workspace ONE UEM Console。
2. 在浏览器的地址栏中，将 URL 中的"cn"替换为"as"，然后将 /api/help 附加到 .com 之后。

例如，适用于 SaaS 环境的 URL 的 API 文档

https://cn4855.awmdm.com

为

https://as4855.awmdm.com/api/help

支持将数据中心 URL 和令牌 URL 用于 OAuth 2.0

Workspace ONE UEM 支持使用 OAuth 2.0 行业标准协议对 REST API 调用进行安全身份验证和授权。Workspace ONE 令牌服务是 OAuth 身份验证的令牌颁发者，并且仅在 SaaS 环境中受支持。令牌 URL 特定于区域。

创建要用于 API 命令的 OAuth 客户端 (SaaS)

您可以创建 OAuth 客户端以用于仅在 SaaS 环境中支持的 API 命令。通过执行以下步骤，为 SaaS 环境创建 OAuth 客户端。

1. 导航到组与设置 > 配置。

2. 在标签为"输入名称或类别"的搜索文本框中输入 OAuth。

3. 选择出现在结果中的 OAuth 客户端管理。此时将显示 OAuth 客户端管理屏幕。

4. 选择添加按钮。

5. 输入名称、说明、组织组和角色。

   注：有关所选角色特定 REST API 权限的更多信息，请参阅本主题中标题为创建可以使用 REST API 的角色的部分。

6. 确保状态为已启用。

7. 选择保存。

8. 重要说明：请先将客户端 ID 和客户端密钥复制到剪贴板并保存，然后再关闭此屏幕。选择"复制"图标（）以将客户端密钥发送到剪贴板。

   选择关闭后，您将无法返回到此处检索这些信息。

9. 采用以下格式使用客户端 ID、客户端密钥和令牌 URL 生成访问令牌：

   HTTP 请求

   API call: POST {以上部分中特定于区域的令牌 URL}

   输入参数

   参数	必需	说明
   tenant_url	是 (URL)	租户的主机名
   grant_type=client_credentials	是（正文）	接收访问令牌时需要
   application/x-www-form-urlencoded	是（标头）	编码格式
   身份验证：基本	是（标头）	您必须传递 client_id:Client_secret 的 Base64 编码字符串

10. 使用返回的访问令牌授权向 Workspace ONE UEM API 服务器发出的未来 API 请求。您必须采用以下方式在请求标头中格式化访问令牌。

    API call: {UEM API}

    键	值
    授权	{访问令牌}

创建可以使用 REST API 的角色

每个 API 调用都具有相应的资源（或权限），您必须将其包含在分配给 OAuth 客户端的角色中。因此，包含在您分配的角色中的权限与您进行的 API 调用类型一致。

使用下表中的信息可帮助您选择必须包含在您分配的角色中的权限。然后，访问基于角色的访问中标题为创建管理员角色的部分，了解有关创建该角色的说明。