LaravelでM365統合: Graph APIの事前準備ガイド

Laravel プロジェクトの設定

パッケージの追加

LaravelからGraph APIをREST APIとして利用するには、Composerを介してパッケージをインストールする必要があります。
Laravel プロジェクトのルートディレクトリから以下のコマンドを実行します。

composer require microsoft/microsoft-graph

問題なくインストールされれば、[composer.json]ファイルに以下のブロックが追加されます。

{
    "require": {
        "microsoft/microsoft-graph": "^2.0.0"
    }
}

環境定数に必要情報を追加

Laravel プロジェクトにMicrosoft Entraで追加したアプリの固有情報を登録します。
[.env]ファイルに「クライアントID」「クライアント シークレット」「テナントID」を登録します。
「クライアントID」「テナントID」はアプリの概要に表示されていますので、コピー＆ペーストします。
定数名は[GRAPH][ENTRA]などで始まる名称にすれば他の定数と混同することは無いと思います。

GRAPH_CLIENT_ID="YOUR_CLIENT_ID"
GRAPH_CLIENT_SECRET="YOUR_CLIENT_SECRET"
# テナントIDは通常"common"を指定する事！
ENTRA_TENANT_ID="common"

現時点で、「クライアント シークレット」はまだ生成していません。
Microsoft Entra 管理センターに戻り「クライアント シークレット」の生成を行います。
赤色またはオレンジ色の枠内をクリックすることで「クライアントシークレット」の管理画面へと遷移します。

「クライアント シークレット」が選択されていることを確認し、”新しいクライアント シークレット”をクリックして「クライアント シークレット」の生成を行います。

最下部にある「追加」ボタンをクリックすると「クライアント シークレット」が生成されアプリに追加されます。追加された”値”が「クライアント シークレット」ですので、値の右側にあるアイコンをクリックしてクリップボードにコピーし、.envファイルの値として張り付けます。
※クライアントシークレットがコピーできるのは生成直後に限られます、ここでコピーし忘れた場合は削除後に再生成を行います。

Graph 認証プロバイダーの作成

いよいよ準備は最終段階へと入ります。
Laravel プロジェクトからGraph APIを利用するために登録したアプリに対する認証を行う「認証プロバイダー」を作成します。作成の概要はClient Credentials Provider(公式)を参照ください。
サンプルコードで使用している変数の情報を以下の表に記載します。

サンプルコード

use Microsoft\Kiota\Authentication\Oauth\ClientCredentialContext;

$clientId = 'YOUR_CLIENT_ID';
$tenantId = 'YOUR_TENANT_ID';
$clientSecret = 'YOUR_CLIENT_SECRET';

$tokenContext = new ClientCredentialContext(
    $tenantId,
    $clientId,
    $clientSecret);

[$tokenContext]が実際に認証を行う「認証プロバイダー」です、この「認証プロバイダー」を生成するためには、[ClientCredentialContext]クラスのインスタンスで[use]句を使ってクラスを参照する必要があります。
※クラスの”nameSpace”を見るとわかりますが、OAuth²を利用した認証を行うクラスで、内部にアクセストークンを保持します。

Graph Service Client の生成

直前に生成した認証プロバイダーを利用して、クライアントを生成します。
クライアントは[GraphServiceClient]クラスで認証プロバイダーとスコープを引数に生成されます。

use Microsoft\Graph\GraphServiceClient;

$scopes = ['https://graph.microsoft.com/.default'];

$client = new GraphServiceClient($tokenContext, $scopes);

以上で事前の準備は完了です。
Graph API の利用は生成した[$client]に対してクエリを発行するだけです。
利用するクエリは許可を得たアクセススコープに限定されることに注意してください。