~SeiyaのWorkspace ONEスペシャリストへの道~

Workspace ONEに関する経験と知識を発信します

Workspace ONEとRest API

皆さんお疲れさまです。Seiyaです。

 

今回は「Workspace ONE UEM API Explorer」を使ってみようと思います。

「Workspace ONE UEM API Explorer」はAPIコマンドをWorkspace ONE UEMへ送信して一度に多くの設定値を出力したり、設定変更を行うときに重宝しています!

 

多くの設定とは具体的に例を挙げると以下のようなものがあります。

  • ユーザー
  • アプリグループの編集
  • 組織グループの編集
  • タグ

 

今回はユーザーの姓名を編集するAPIコマンドについて紹介します。

 

APIコマンドを使うためには以下のものが必要です。

  • Workspace ONE UEMの管理者ユーザーのユーザー名とパスワード
  • Workspace ONE UEMに登録されているAPIキー

   APIキーはWorkspace ONE UEMの以下設定から確認できます。

   すべての設定>システム>高度な設定>API

  • 編集したいユーザーアカウントのユーザーのID

 

APIコマンドの使い方

1.「https://{UEMのサーバ名}/api/help」へアクセスする。

  ※UEMのサーバ名は環境により異なります。

   本記事では「cn802awmdm.com」を使用しています。

 

2.APIsタブへ移動して、使用するコマンドを選択する。

  今回は「System Management REST API V1」を選択します。

f:id:uenoseiy:20210108225123p:plain

API一覧

3.API Referenceタブへ移動し、右上の「AUTHORIZE」から認証を行う。

  username:UEMの管理者ユーザーのユーザー名

  password:UEMの管理者ユーザーのパスワード

  value:Workspace ONE UEMに登録されているAPIキー

  ※管理者ユーザーとAPIキーはそれぞれを入力するごとに

   「Authorize」をクリックして認証する必要があります。

f:id:uenoseiy:20210108221755p:plain

Login

 

 4.Workspace ONE UEMから編集するユーザーのIDを確認します。

  ユーザーのリスト表示からユーザー名にカーソルを合わせると、

  左下にIDが表示されます。

f:id:uenoseiy:20210108222857p:plain

ユーザーID

 

5.APIのリストから「/users/{id}/update」を展開し、idとuserへ

  それぞれ以下の値を入力します。

  id:手順4で確認したユーザーのID

  user:変更を加える設定値

  ※Model Example Valueからサンプルを取得することができます。

f:id:uenoseiy:20210108232256p:plain

変更を加える設定値

 

6.下へスクロールし、「Try it out」をクリックします。

  ※Response Codeが200であれば、処理は正常に終了しています。

 

7.Workspace ONE UEMで対象のユーザーの値を確認します。

f:id:uenoseiy:20210108233041p:plain

設定値比較

 

手順5で設定した値が反映されていますね。

 

以上で「Workspace ONE UEM API Explorer」の使用手順は終わりです!

 

APIを利用すればWorkspace ONE UEMで手動入力するより作業のコストをカットすることができます。

応用編となりますが、手順5で使用する値をcsvやエクセルファイルなどから自動で読み込み、繰り返し実行するようにすればさらに設定を簡略化できます!

 

また、手動で設定するよりもヒューマンエラーを軽減できるため、おすすめです。

 

今回は実際の作業の流れを含め紹介したので、少し長くなってしまいましたが皆さんの参考になればと思います!

 

今後も便利機能や利用手順を紹介できたらと思いますので

引き続き、ご愛読よろしくお願いします!