こんにちは。めだか鉢の睡蓮が咲きました。tkです。
構築や運用を効率化するために、APIを使いたいときってありますよね。
Workspace ONEでもAPIが用意されています！
今回は「Workspace ONE UEM API Explorer」についてです！
【Workspace ONE UEM API Explorer とは】
Workspace ONE UEM API Explorer を使用する際には、以下URLへアクセスします。
https://<UEMのFQDN>/api/help/#!/apis
UEM上のユーザー、デバイス、グループ、アプリケーションに関する情報を取得、設定ができます。
【Workspace ONE UEM API Explorer 使用前の事前準備】
API Explorerを使用するために、以下３つの情報が必要なので事前に確認しておきましょう。
(1) Username
UEMコンソールにログインする際に利用するユーザー名とパスワード
(2) API key
[グループと設定] > [すべての設定]
> [システム] > [高度な設定] >
[API] > [REST API] をクリックし、「AirWatchAPI」のAPIキーをコピーする。
(3) Group ID
加入等で使うグループID。
[グループと設定] > [グループ] >
[組織グループ] > [詳細] より確認。
【Workspace ONE UEM API Explorer 使用例】
今回はユーザー情報すべてを取得してみます。
①Workspace ONE UEM API Explorerにアクセスする。
https://<UEMのFQDN>/api/help/#!/apis
②検索欄でキーワードを検索する。今回は「user」で検索し、「/users/search」をクリックする。
③「AUTHORIZE」をクリックして、事前準備で取得した認証情報を入力する。
④「/users/search」でパラメータは特に入力せず、「Try it out!」をクリックする。
※コマンドによってはパラメターが必須のものもある
実際に実行されるcurlコマンドも教えてくれるので、これをそのままLinuxから実行しても同じ結果が得られます。
Windowsの場合はPowerShellでcurl部分を「curl.exe」にすると実行できますが、レスポンスが改行されていないなど見にくかったです。
実行例）curl.exe -X GET --header 'Accept: application/json' --header 'aw-tenant-code: XXXXXXXXXX' --header 'Authorization: Basic XXXXXXXXXX' 'https://as802.awmdm.com/API/system/users/search'
WindowsのPowerShellにおいてcurlはInvoke-WebRequestのエイリアスとなっています。curl.exeと入力するとcurlコマンドが実行できますが、PowerShellでAPI操作をするならInvoke-WebRequestで組んだほうがよさそうです。
【まとめ】
Workspace ONE UEM API Explorer の使い方の基本を確認しました。
APIについては他にもいろいろなやり方があるので、また記事を書きたいと思います。
