Workspace ONE UEM をAPIで操作する(Postman)

2022/07/07

API Workspace ONE メッセージ送信

t f B! P L

 こんにちは。メダカと一緒に育てている姫睡蓮が花を咲かせました。
tkです。

前回に引き続きAPIに関連する検証です。

「Postman」を使ってWorkspace ONE を操作したいと思います!

タイトルはWorkspace ONE UEM となっていますが、実際はAccess中心です(笑)

【Postman とは】

有名なAPIテストツールです。
リクエストから認証、テストなどの機能が搭載されており、APIを開発する作業を簡素化、作業効率を向上させることができます。
APIに詳しくないインフラエンジニアの私でも簡単に使うことができます。

ダウンロードはこちらから↓↓
Download Postman | Get Started for Free

【Workspace ONE Hub 通知をAPIで実施】

以下VMware Tech Zoneにて、Postmanを使ったHub通知について紹介されています。
Automating Notifications: Workspace ONE Operational Tutorial | VMware

上記記事の大まかな流れとしては以下の通りです。
①Workspace ONE Access でサービスクライアントトークンの作成
②Postmanの構成
③PostmanからAPIを実行

今回はこの記事の内容を検証していきます。

Hubサービスの通知については本ブログにも記事がありますので、ぜひそちらもご一読ください。(リンク

【Access:サービスクライアントトークンの作成】

APIの認証で使うトークンの設定を行います。

①Workspace ONE Accessにログインし、[カタログ] > [設定] をクリックする。

②「クライアントを作成」をクリックする。

③「クライアントを作成」画面で以下を設定する。
  アクセスの種類:サービスクライアントトークン
  クライアントID:任意の名前を設定
  共有シークレット:「共有シークレットを生成」をクリック。
   あとから確認できないため、シークレットはコピーして残しておくこと

設定したクライアントIDと共有シークレットはあとで使います。

【Postman:Workspace ONE 環境構成】

①以下URLからWorkspace ONEのAPIコレクションと環境変数定義をダウンロードする。
Automating Notifications: Workspace ONE Operational Tutorial | VMware


②PostmanのWorkspaceでコレクションを選択し、「import」をクリックする。

③ダウンロードしたAPIコレクションと環境変数定義を選択し、「import」をクリックする。

④Postmanの右上からインポートした環境変数定義を選択する。

⑤目のアイコンをクリックし、「Edit」をクリックする。

⑥以下の通り「CURRENT VALUE」設定し、「Save」をクリックする。
CURRENT VALUE設定値
access_tenant_hostWorkspace ONE Access コンソール FQDN(xxxxxx.vidmpreview.com)
client_id事前に作成したWorkspace ONE Access OAuth2 ID
client_secret事前に作成したWorkspace ONE Access OAuth2 シークレット
access_token未指定 ※利用中に自動設定
uem_tenant_hostUEM REST API サーバー FQDN(cnXXXX.awmdm.com)
uem_api_keyUEM管理者APIキー(確認方法については前回の記事を参照)
uem_admin_usernameUEM管理者ユーザー名
uem_admin_passwordUEM管理者ユーザーパスワード
refresh_token未指定 ※利用中に自動設定

【APIによるWorkspace ONE Hub通知】

インポートしたAPIのコレクションを使い、APIを発行してHub通知を作成します。

トークン取得

Accessの認証トークンを取得します。

①[WS1 Notification APIs] > [Authentication] > [Get Access Token] をクリックする。

②「Send」をクリックする。実行結果が下部に表示される。

Workspace ONE AccessのID取得

Hub通知をAPIで作成するには、送信先となるAccessユーザーのIDが必要です。
Workspace ONE Access のユーザー情報を取得し、IDを確認します。

①[WS1 Notification APIs] > [Query Users and Devices] > [Access | Find User IDs (All Users)] をクリックする。

②「Send」をクリックする。実行結果が下部に表示される。
 実行結果をテキストなどにコピーし、「id」を確認する。
 (External IDはUEM上のID。)

Workspace ONE Hub 通知の作成

Hub通知ではリンクや動画の埋め込みなど様々可能です。
もちろんAPIでもできますが、今回はシンプルな通知を実行してみます。

①[WS1 Notification APIs] > [Notifications] > [Send Single-User Notifications] > [Users] > [Send Standard Notification to User] をクリックする。

②『{USER_UUID}』部分をAccessのIDに置き換える。


 『:USER_UUID』とするとパス変数として指定できるようになる。

③通知内容となる「Body」を編集する。タイトルや本文などを適宜変更する。

④「Send」をクリックして通知を作成し、実行結果を確認する。

【まとめ】

Postman を使ったAPIによるHub通知についてまとめました。
Hub通知やID検索はVMwareがコレクションを用意してくれているので、簡単に実施することができます。

当然デフォルトで用意されていないコマンドも実行できます。
Workspace ONE UEM Explorerとコレクションにあるコマンドを参考にすると簡単にできるので、ぜひ皆さんもやってみてください!

次回はWindows PowerShell です!

自己紹介

自分の写真
インフラ系システムエンジニア。Omnissa (旧VMware) Workspace ONEを専門に扱うことになったため、お勉強と備忘のためにブログを始めることに。

・VCP-DW 2022
・vExpert 2024
・Omnissa Certified Administrator – Workspace ONE
・2026 Omnissa Tech Insiders

X : https://x.com/a2px3ufsjnwcuef?s=21&t=D8E-kTvlDF8LLprCK1vuxA

このブログを検索

連絡フォーム

名前

メール *

メッセージ *

QooQ