您可透過將 REST API 與 UEM 基礎結構整合並協助連線,以設定外部應用程式使用 Workspace ONE UEM 的核心產品功能。您也可以選取最接近您資料中心的 OAuth Token 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 說明文件。

若要在 SaaS 環境中執行此操作,請用「as」取代 URL 中的「cn」,然後在 .com 後面附加 /api/help

例如,SaaS 環境的 API 說明文件的 URL
https://cn4855.awmdm.com
https://as4855.awmdm.com/api/help

支援 OAuth 2.0 的資料中心和 Token URL

Workspace ONE UEM 支援 OAuth 2.0 業界標準通訊協定,以進行 REST API 呼叫的安全驗證和授權。

Workspace ONE Token 服務是 OAuth 驗證的 Token 簽發者,目前僅能在 SaaS 環境中獲得支援。Token URL 為區域特定。

表 1. 區域特定的 Token URL
區域 Workspace ONE UEM SaaS 資料中心位置 Token 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

建立 API 命令適用的 OAuth 用戶端 (SaaS)

您可以建立僅在 SaaS 環境中獲得支援,API 命令適用的 OAuth 用戶端。透過執行下列步驟,針對您的 SaaS 環境建立 OAuth 用戶端。

  1. 導覽至 群組 & 設定 > 組態
  2. 在標示為「輸入名稱或類別」的搜尋文字方塊中輸入 OAuth
  3. 選取結果中顯示的 OAuth 用戶端管理OAuth 用戶端管理畫面即會顯示。
  4. 點選新增鍵。
  5. 輸入名稱說明企業群組,以及角色
    備註: 如要進一步瞭解關於所選角色的特定 REST API 權限,請參閱本主題中〈 建立可以使用 REST API 的角色〉區段。
  6. 確定狀態啟用
  7. 選取儲存
  8. 重要:用戶端 ID用戶端密碼複製到剪貼簿,然後在關閉此畫面之前加以儲存。選取剪貼簿圖示 (),將用戶端密碼傳送至剪貼簿。

    選取關閉後,您無法回到此處擷取這些資訊。

  9. 使用用戶端 ID、用戶端密碼和 Token URL,產生以下格式的存取 Token:

    API 呼叫:POST {來自前述區段的地區特定 Token URL}

    grant_type client_credentials
    client_id {在 UEM 主控台上產生的 CLIENT ID}
    client_secret {在 UEM 主控台上產生的 CLIENT SECRET}
  10. 使用傳回的存取 Token,將未來的 API 要求授權至 Workspace ONE UEM API 伺服器。必須以下列格式,在要求標頭中提供存取 Token。

    API 呼叫:{UEM API}

    授權 [存取 Token}

建立可以使用 REST API 的角色

您要執行的每個 API 呼叫都具有相應的資源 (或權限),您必須將其包含在指派給 OAuth 用戶端的角色中。因此,要在您指派的角色中納入的權限,與您要執行的 API 呼叫類型一致。

使用下表中的資訊,以便選擇必須將哪些權限包含在您指派的角色中。接著前往 建立管理員身份,瞭解有關建立該角色的說明。
表 2. REST API 角色權限
類別 名稱 描述 唯讀/編輯
REST > 管理員 REST API 系統群組 存取企業群組資訊 編輯
REST API 系統管理員 存取管理員資訊 編輯
REST API 系統使用者 存取使用者資訊 編輯
REST API 管理員寫入 啟用對管理員使用者集合內所有寫入/更新 API 的存取 編輯
REST API 管理員執行 啟用對管理員使用者集合內所有執行 API 的存取 編輯
REST API 管理員刪除 啟用對管理員使用者集合內所有刪除 API 的存取 編輯
REST API 管理員讀取 啟用對管理員使用者集合內所有唯讀 API 的存取 唯讀
REST > 應用程式 REST API MAM Blob 上傳下載內容 編輯
REST API MAM 應用程式 存取受管理的應用程式 編輯
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 BLOB 寫入 啟用對 BLOB 集合內所有僅限寫入/更新 API 的存取 編輯
REST API BLOB 執行 啟用對 BLOB 集合內所有僅限執行 API 的存取 編輯
REST API BLOB 刪除 啟用對 BLOB 集合內所有僅限刪除 API 的存取 編輯
REST API 裝置寫入 啟用對裝置集合內所有寫入/更新 API 的存取 編輯
REST API 裝置執行 啟用對裝置集合內所有執行 API 的存取 編輯
REST API 裝置刪除 啟用對裝置集合內所有刪除 API 的存取 編輯
REST API 裝置進階 啟用對裝置集合內所有進階 API 的存取 編輯
REST API BLOB 讀取 啟用對 BLOB 集合內所有唯讀 API 的存取 唯讀
REST API 裝置讀取 啟用對裝置集合內所有唯讀 API 的存取 唯讀
REST > REST 企業整合 REST API 企業整合讀取 啟用對企業整合內所有唯讀 API 的存取 唯讀
REST > 群組 REST API 群組寫入 啟用對企業群組集合內所有寫入/更新 API 的存取 編輯
REST API 群組執行 啟用對企業群組集合內所有執行 API 的存取 編輯
REST API 群組刪除 啟用對企業群組集合內所有刪除 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 寫入 用來啟動 Apple School Manager 同步的 REST API 編輯
REST API Apple School Manager 對應 用來將註冊使用者對應到 Apple School Manager 成員的 REST API 編輯
REST API 類別指派儲存 用來儲存類別指派的 REST API 呼叫 編輯
REST API 類別寫入 用來儲存和編輯類別資料的 REST API 編輯
REST API 類別刪除 用來刪除類別資料的 REST API 編輯
REST API 教育設定寫入 用來儲存和編輯教育設定的 REST API 編輯
REST API 教育設定讀取 用來檢視教育設定的 REST API 編輯
REST API 群組讀取 啟用對企業群組集合內所有唯讀 API 的存取 唯讀
REST API 智慧群組讀取 啟用對智慧群組集合內所有唯讀 API 的存取 唯讀
REST API 使用者群組讀取 啟用對使用者群組內所有唯讀 API 的存取 唯讀
REST API Apple School Manager 同步讀取 用來檢查 Apple School Manager 同步狀態的 REST API 唯讀
用於裝置讀取的 REST API 應用程式 用來取得符合裝置條件之應用程式清單的 REST API 唯讀
REST API 類別讀取 用來檢視類別資料的 REST API 唯讀
REST > 產品 REST API 產品執行 啟用對產品集合內所有執行 API 的存取 編輯
REST API 產品寫入 啟用對產品集合內所有寫入 API 的存取 編輯
REST API 產品刪除 啟用對產品集合內所有刪除 API 的存取 編輯
REST API 產品讀取 啟用對產品集合內所有唯讀 API 的存取 唯讀
REST > 設定檔 更新原則寫入存取 啟用對更新原則集合內所有寫入 API 的存取 編輯
更新原則執行存取 啟用對更新原則集合內所有執行 API 的存取 編輯
更新原則刪除存取 啟用對更新原則集合內所有刪除 API 的存取 編輯
REST API 設定檔寫入 啟用對設定檔集合內所有寫入 API 的存取 編輯
REST API 設定檔執行 啟用對設定檔集合內所有執行 API 的存取 編輯
REST API 設定檔刪除 啟用對設定檔集合內所有刪除 API 的存取 編輯
更新原則讀取存取 啟用對更新原則集合內所有唯讀 API 的存取 唯讀
REST API 設定檔讀取 啟用對設定檔集合內所有唯讀 API 的存取 唯讀
REST > 使用者 REST API 使用者寫入 啟用對註冊使用者集合內所有寫入/更新 API 的存取 編輯
REST API 使用者執行 啟用對註冊使用者集合內所有執行 API 的存取 編輯
REST API 使用者刪除 啟用對註冊使用者集合內所有刪除 API 的存取 編輯
REST API 使用者 Token 讀取 啟用對註冊使用者集合內 API 註冊使用者 Token 的存取 唯讀
REST API 使用者讀取 啟用對註冊使用者集合內所有唯讀 API 的存取 唯讀