REST API による UEM 機能の使用

REST API と UEM インフラストラクチャを統合し、接続を容易にすることで、Workspace ONE UEM の主要な製品機能を使用するよう外部アプリケーションを構成できます。また、データセンターに最も近い OAuth トークン URL を選択して、API 呼び出しを認証することもできます。

REST API の使用を開始する

現在、Workspace ONE UEM REST API はシンプルな REST ソフトウェア アーキテクチャ使用して、組織グループ、コンソール管理、モバイル アプリ、モバイル デバイス、E メール、加入ユーザー、プロファイル、スマート グループ、ユーザー グループ管理など、さまざまな機能をサポートしています。

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」に置き換え、.com の後に /api/help を追加します。

たとえば、SaaS 環境の URL の API ドキュメント

https://cn4855.awmdm.com

...は...

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

OAuth 2.0 をサポートするデータセンターとトークンの URL

Workspace ONE UEM は、REST API コールの認証と承認を安全に行うために、業界標準の OAuth 2.0 プロトコルをサポートしています。Workspace ONE トークン サービスは OAuth 認証用のトークン発行機能であり、SaaS 環境でのみサポートされます。トークン URL は地域固有です。

API コマンド (SaaS) に使用する OAuth クライアントを作成する

API コマンドに使用する OAuth クライアントを作成できます。こちらは SaaS 環境でのみサポートされます。SaaS 環境向けに OAuth クライアントを作成するには、次の手順を実行します。

1. [グループと設定] > [構成] の順に移動します。

2. 「名前またはカテゴリを入力します」というラベルの付いた検索ボックスに「OAuth」と入力します。

3. 検索結果に表示される OAuth クライアント管理 を選択します。[OAuth クライアント管理] 画面が表示されます。

4. [追加] ボタンを選択します。

5. 名前、説明、組織グループ、役割を入力します。

   **注：**選択した役割の特定の REST API 権限の詳細については、「REST API を使用できる役割を作成する」セクションを参照してください。

6. ステータスが有効になっていることを確認します。

7. [保存] を選択します。

8. 重要：クライアント ID とクライアント シークレットをクリップボードにコピーして、保存してからこの画面を閉じます。[コピー] アイコン（）を選択して、クライアント シークレットをクリップボードに送信します。

   閉じる を選択すると、後で情報を参照するために、この表示に戻ることはできません。

9. クライアント ID、クライアント シークレット、トークン URL を使用して、次の形式でアクセス トークンを生成します。

   HTTP 要求

   API 呼び出し：POST {Region-Specific Token URL from section above}

   入力パラメータ

   パラメータ	必須	説明
   tenant_url	はい (URL)	テナントのホスト名
   grant_type=client_credentials	はい（本文）	アクセス トークンを受け取るために必要
   application/x-www-form-urlencoded	はい（ヘッダー）	エンコーディングの形式
   自動化：基本	はい（ヘッダー）	client_id:Client_secret の Base64 エンコード文字列を渡す必要があります。

10. 返されたアクセス トークンを使用して、それ以降の Workspace ONE UEM API サーバへの API 要求を認証します。要求ヘッダーのアクセス トークンは、次のようにフォーマットする必要があります。

    API 呼び出し：{UEM API}

    キー	付加価値
    認証	{アクセス トークン}

REST API を使用できる役割を作成する

各 API 呼び出しでは、対応するリソース（または権限）を、OAuth クライアントに割り当てるロールに含める必要があります。したがって、割り当てるロールを含める権限は、意図する API 呼び出しの種類と一致します。

次の表にある情報を利用して、割り当てるロールに含める必要がある権限を選択してください。そのロールの作成手順については、ロールベースのアクセスの「管理者ロールの作成」というタイトルのセクションを参照してください。