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 ドキュメントを参照します。

ブラウザのアドレスバーで、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 は地域固有です。

リージョン	Workspace ONE UEM SaaS データセンターのロケーション	トークン URL
オハイオ (米国)	すべての UAT 環境	`https://uat.uemauth.vmwservices.com/connect/token`
バージニア (米国)	United States	`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 コマンド (SaaS) に使用する OAuth クライアントを作成する

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

[グループと設定] > [構成] の順に移動します。
「名前またはカテゴリを入力します」というラベルの付いた検索ボックスに「OAuth」と入力します。
検索結果に表示される OAuth クライアント管理 を選択します。OAuth ライアント管理 画面が表示されます。
追加ボタンを選択します。
名前、説明、組織グループ、役割を入力します。

注：選択した役割の特定の REST API 権限の詳細については、このトピックの「REST API を使用できる役割を作成する」セクションを参照してください。
ステータス が有効になっていることを確認します。
[保存] を選択します。
重要: クライアント ID と クライアントシークレット をクリップボードにコピーして、保存してからこの画面を閉じます。コピーアイコン（）を選択して クライアントシークレット をクリップボードに送信します。

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

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

API 呼び出し：POST {上記セクションの地域固有のトークン URL}

キー	付加価値
grant_type	client_credentials
client_id	{UEM console で生成されたクライアント ID}
client_secret	{UEM console で生成されたクライアントシークレット}

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

API 呼び出し：{UEM API}

キー付加価値

認証 {アクセストークン}

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

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

各 API 呼び出しでは、対応するリソース（または権限）を、OAuth クライアントに割り当てるロールに含める必要があります。したがって、割り当てるロールを含める権限は、意図する 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 BLOBS 書き込み	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 ユーザートークン読み取り	加入ユーザーコレクションで、API の加入ユーザートークンへのアクセスを有効にする	閲覧のみ
	REST API ユーザー読み取り	加入ユーザーコレクションのすべての｢読み取り専用｣API を使用する権限を有効化します	閲覧のみ