Microsoft GraphAPIをつかってみよう。-- 実践 編--

7460 ワード
Office365 GraphAPI MicrosoftGraph PowerShell 初心者 PowerShell テキストリンク

・はじめに

前回は、Microsoft Graph APIを利用するためのアプリ登録手順についてお話ししました。
※Microsoft Graph APIをつかってみよう。-- 事前準備 編--

今回は、登録したアプリを使って PowerShell で GraphAPI を利用し、情報取得するまでをご説明します。

・クライアント資格情報による認証

Microsoft Graph にアクセスする際は認証が必要になります。
その認証方法は下記の４パターンです。
　・デバイスコードによる認証
　・認証コードによる認証
　・パスワードによる認証
　・クライアント資格情報による認証

今回は「クライアント資格情報による認証」に絞って紹介します。

この認証方法は、サインインを必要とせずMicrosoft Graphに対して認証することができます。
実行時にサインインを求められないため「自動化されたタスクやスクリプト」に最適です。

例として「自分の組織のすべてのグループ」を取得するためのサンプルを用意しました。
PowerShellで下記ソースコードを実行すると「自分の組織のすべてのグループ」を取得できます。
※<>内は登録したアプリの情報に修正してください。

・サンプルコード

#######################GraphAPI接続 start
$clientid = "<アプリケーション（クライアント）ID>"
$tenantName = "<アプリを登録したテナントのドメイン>　例（QiitaTest2020.onmicrosoft.com）"
$clientSecret = "<クライアント シークレット>"

$ReqTokenBody = @{
    Grant_Type    = "client_credentials"
    Scope         = "https://graph.microsoft.com/.default"
    client_Id     = $clientID
    Client_Secret = $clientSecret
} 

$TokenResponse = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$tenantName/oauth2/v2.0/token" -Method POST -Body $ReqTokenBody
#######################GraphAPI接続 end

#######################GraphAPIで情報取得
$apiUrl = 'https://graph.microsoft.com/v1.0/Groups/'
$Data = Invoke-RestMethod -Headers @{Authorization = "Bearer $($Tokenresponse.access_token)"} -Uri $apiUrl -Method Get
$Groups = ($Data | select-object Value ).Value
$Groups | Format-Table DisplayName, Description -AutoSize

解説

アクセストークン取得

前回登録したアプリでアクセストークンを取得します。
アクセストークンには、アプリ自体とアプリに付与されているアクセス許可に関する情報が含まれており、このアクセストークンを取得してGraph APIを利用可能にし、Microsoft Graphにアクセスして情報を取得します。

２行目～１３行目でアクセストークンを取得します。
　２行目：Azure ADで登録したアプリの「アプリケーション（クライアント）ID」を入力します。
　３行目：「アプリを登録したテナントのドメイン」を入力します。
　４行目：Azure ADで登録したアプリの「クライアント シークレット」を入力します。
　※今回クライアント シークレットはハードコーディングしていますが、パスワードと同じ扱いをする必要があるため、実稼働する場合は暗号化するなどしてください。

$clientid = "<アプリケーション（クライアント）ID>"
$tenantName = "<アプリを登録したテナントのドメイン>　例（QiitaTest2020.onmicrosoft.com）"
$clientSecret = "<クライアント シークレット>"

６行目～１１行目で「クライアント資格情報による認証」を実施します。

$ReqTokenBody = @{
    Grant_Type    = "client_credentials"
    Scope         = "https://graph.microsoft.com/.default"
    client_Id     = $clientID
    Client_Secret = $clientSecret
}

１３行目でアクセストークンを取得します。

$TokenResponse = Invoke-RestMethod -Uri "https://login.microsoftonline.com/$tenantName/oauth2/v2.0/token" -Method POST -Body $ReqTokenBody

Graph APIの指定

１７行目：Graph APIを指定します。指定するGraph APIは下記手順に従って確認します。

$apiUrl = '<Graph API>'　例（'https://graph.microsoft.com/v1.0/Groups/'）

ソースコードに記載するGraph APIを探す方法

１．下記URLにアクセスします。
　　アクセスした際にサインインする必要はありません。
　（https://developer.microsoft.com/ja-jp/graph/graph-explorer#）
２．左側メニューの「サンプル クエリの検索」で、利用するAPIをキーワード検索します。
３．左側メニューから利用するAPIをクリックします。
４．画面上部にAPIが表示されるのでコピーします。
「自分の組織内のすべてのグループ」の場合は　https://graph.microsoft.com/v1.0/groups です。

Graph APIの実行

１８行目：Graph APIを実行します。

$Data = Invoke-RestMethod -Headers @{Authorization = "Bearer $($Tokenresponse.access_token)"} -Uri $apiUrl -Method Get

１９行目：Graph APIを通して取得したデータから、「Value」のみを抽出します。
２０行目：Valueから「表示名」列と「説明」列を抽出します。

$Groups = ($Data | select-object Value ).Value
$Groups | Format-Table DisplayName, Description -AutoSize

取得結果

実行した結果、こんな感じで情報を取得できました。

displayName           description
-----------           -----------
テストチーム５       　説明文５
テストチーム２       　説明文２
PowerShell作成チーム１ 説明文
テストチーム３       　説明文３
テストチーム４       　説明文４

取得した結果はソート順、抽出条件、表示件数を指定していません。
２０行目を下記のどれかに変更することでソート順、抽出条件、表示件数を調整できます。

# オプション例--------------------------------
# フィルター
$Groups | Where-Object {$_.description -match "^説明文*"} | Format-Table DisplayName, Description -AutoSize
# ソート順変更（-Descending：降順、未入力：昇順）
$Groups | Sort-Object Description -Descending　| Format-Table DisplayName, Description -AutoSize
# 表示数変更（-First：先頭から〇個、-Last：末尾から〇個）
$Groups | select-Object -First 3 | Format-Table DisplayName, Description -AutoSize
# フィルター　表示数　表示列（左から順に実行されていく、フィルターと表示数の定義が逆になると結果も変わってしまう）
$Groups | Where-Object {$_.description -match "^説明文*"} | select-object -first 3 | Format-Table DisplayName, Description -AutoSize

参考ページ

CONNECT AND NAVIGATE THE MICROSOFT GRAPH API WITH POWERSHELL
https://www.thelazyadministrator.com/2019/07/22/connect-and-navigate-the-microsoft-graph-api-with-powershell/#Admin_Consent

PowerShellでMicrosoft Graph APIを使用する
https://adamtheautomator.com/microsoft-graph-api-powershell/

リストグループ（MS公式サイト）
https://docs.microsoft.com/en-us/graph/api/group-list?view=graph-rest-1.0&tabs=http

Graph エクスプローラー（MS公式サイト）
https://developer.microsoft.com/ja-jp/graph/graph-explorer