使用 Microsoft Graph 和僅限應用程式驗證建置 PHP 應用程式
本教學課程會教導您如何建置 PHP 控制台應用程式,以使用 Microsoft 圖形 API 來存取使用僅限應用程式驗證的數據。 對於需要存取組織中所有用戶數據的背景服務或應用程式而言,僅限應用程式驗證是不錯的選擇。
注意
若要瞭解如何使用 Microsoft Graph 代表使用者存取數據,請參閱此 使用者 (委派) 驗證教學課程。
在本教學課程中,您將:
提示
除了遵循本教學課程,您可以下載或複製 GitHub 存放庫 ,並遵循自述檔中的指示來註冊應用程式並設定專案。
必要條件
開始本教學課程之前,您應該已在開發計算機上安裝 PHP 和 Composer 。
您也應該擁有具有全域管理員角色Microsoft公司或學校帳戶。 如果您沒有Microsoft 365 租使用者,您可能有資格透過 Microsoft 365 開發人員計劃;如需詳細資訊,請參閱 常見問題。 或者,您可以 註冊 1 個月的免費試用版,或購買Microsoft 365 方案。
注意
本教學課程是以 PHP 8.1.5 版和 Composer 2.3.5 版所撰寫。 本指南中的步驟可能適用於其他版本,但尚未經過測試。
在入口網站中註冊應用程式
在此練習中,您將在 Azure Active Directory 中註冊新的應用程式,以啟用 僅限應用程式的驗證。 您可以使用 Microsoft Entra 系統管理中心或使用 Microsoft Graph PowerShell SDK 來註冊應用程式。
註冊應用程式以進行僅限應用程式驗證
在本節中,您將使用 用戶端認證流程註冊支援僅限應用程式驗證的應用程式。
開啟瀏覽器並流覽至 Microsoft Entra 系統管理中心 ,並使用全域系統管理員帳戶登入。
選Microsoft左側導覽中的 [Entra ID ],依序展開 [ 身分識別]、[ 應用程式],然後選取 [ 應用程式註冊]。
選取 [新增註冊]。 輸入應用程式名稱,例如
Graph App-Only Auth Tutorial
。將 [支持的帳戶類型] 設定為 [僅限此組織目錄中的帳戶]。
將 [重新導向 URI ] 保留空白。
選取 [登錄]。 在應用程式的 [ 概觀 ] 頁面上,複製應用程式 (用戶端) 標識 符和 目錄 (租使用者) 標識 符的值並加以儲存,您在下一個步驟中將需要這些值。
在 [管理] 底下,選取 [API 權限]。
選取其數據列中的省略號 (...) ,然後選取 [移除許可權],以移除 [設定的許可權] 下的默認 User.Read 許可權。
選 取 [新增許可權],然後 Microsoft圖形]。
選取 應用程式權限。
選 取 [User.Read.All],然後選取 [ 新增許可權]。
選 取 [授與系統管理員同意...],然後選取 [ 是 ] 以提供所選許可權的管理員同意。
選取 [管理] 底下的 [憑證和秘密],然後選取 [新增客戶端密碼]。
輸入描述,選擇持續時間,然後選取 [ 新增]。
從 [ 值 ] 資料行複製秘密,您在後續步驟中將需要它。
重要
此用戶端密碼永不再顯示,因此現在請您確認將其複製。
注意
請注意,與註冊用戶驗證時的步驟不同,在本節中,您已設定Microsoft應用程式註冊的 Graph 許可權。 這是因為僅限應用程式的驗證會使用客戶端 認證流程,這需要在應用程式註冊上設定許可權。 如需詳細資訊,請參閱 .default 範圍。
建立 PHP 主控台應用程式
從初始化新的 Composer 項目開始。 在您要建立項目的目錄中, (CLI) 開啟命令行介面。 執行下列指令:
composer init
回答提示。 您可以接受大部分問題的預設值,但回應 n
下列事項:
Would you like to define your dependencies (require) interactively [yes]? n
Would you like to define your dev dependencies (require-dev) interactively [yes]? n
Add PSR-4 autoload mapping? Maps namespace "Microsoft\Graphapponlytutorial" to the entered relative path. [src/, n to skip]: n
安裝相依性
繼續之前,請新增一些您稍後將使用的額外相依性。
- Microsoft Graph SDK for PHP 呼叫 Microsoft Graph。
- vlucas/phpdotenv ,用於從 .env 檔案讀取環境變數。
在 CLI 中執行下列命令以安裝相依性。
composer require microsoft/microsoft-graph vlucas/phpdotenv
載入應用程式設定
在本節中,您會將應用程式註冊的詳細數據新增至專案。
在專案根目錄中建立名為 .env 的檔案,並新增下列程序代碼。
CLIENT_ID=YOUR_CLIENT_ID_HERE CLIENT_SECRET=YOUR_CLIENT_SECRET_HERE_IF_USING_APP_ONLY TENANT_ID=YOUR_TENANT_ID_HERE_IF_USING_APP_ONLY
根據下表更新值。
設定 值 CLIENT_ID
應用程式註冊的用戶端識別碼 CLIENT_SECRET
應用程式註冊的客戶端密碼 TENANT_ID
貴組織的租用戶標識碼 重要
如果您使用 git 之類的原始檔控制,現在是將 .env 檔案從原始檔控制中排除的好時機,以避免不小心洩漏您的應用程式識別符。
設計應用程式
在本節中,您將建立簡單的控制台型功能表。
在專案根目錄中建立名為 main.php 的檔案。 新增開頭和結尾 PHP 標籤。
<?php ?>
在 PHP 標記之間新增下列程式代碼。
// Enable loading of Composer dependencies require_once realpath(__DIR__ . '/vendor/autoload.php'); require_once 'GraphHelper.php'; print('PHP Graph Tutorial'.PHP_EOL.PHP_EOL); // Load .env file $dotenv = Dotenv\Dotenv::createImmutable(__DIR__); $dotenv->load(); $dotenv->required(['CLIENT_ID', 'CLIENT_SECRET', 'TENANT_ID']); initializeGraph(); $choice = -1; while ($choice != 0) { echo('Please choose one of the following options:'.PHP_EOL); echo('0. Exit'.PHP_EOL); echo('1. Display access token'.PHP_EOL); echo('2. List users'.PHP_EOL); echo('3. Make a Graph call'.PHP_EOL); $choice = (int)readline(''); switch ($choice) { case 1: displayAccessToken(); break; case 2: listUsers(); break; case 3: makeGraphCall(); break; case 0: default: print('Goodbye...'.PHP_EOL); } }
在關閉 PHP 標記之前,於檔案結尾處新增下列佔位符方法。 您將在後續步驟中實作它們。
function initializeGraph(): void { // TODO } function displayAccessToken(): void { // TODO } function listUsers(): void { // TODO } function makeGraphCall(): void { // TODO }
這會實作基本功能表,並從命令行讀取用戶的選擇。
新增僅限應用程序驗證
在本節中,您會將僅限應用程式的驗證新增至應用程式。 這是取得必要的 OAuth 存取令牌以呼叫 Microsoft Graph 的必要專案。
設定僅限應用程式驗證的 Graph 用戶端
在本節中, PhpLeagueAuthenticationProvider
您將使用 類別,使用 用戶端認證流程來要求存取令牌。
在專案根目錄中建立名為 GraphHelper.php 的新檔案。 新增下列程式碼。
<?php class GraphHelper { } ?>
在 PHP 標籤新增下列
using
語句。use Microsoft\Graph\Core\Authentication\GraphPhpLeagueAccessTokenProvider; use Microsoft\Graph\Generated\Models; use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetQueryParameters; use Microsoft\Graph\Generated\Users\UsersRequestBuilderGetRequestConfiguration; use Microsoft\Graph\GraphServiceClient; use Microsoft\Kiota\Authentication\Oauth\ClientCredentialContext;
將下列程式碼新增至
GraphHelper
類別。private static string $clientId = ''; private static string $clientSecret = ''; private static string $tenantId = ''; private static ClientCredentialContext $tokenContext; private static GraphServiceClient $appClient; public static function initializeGraphForAppOnlyAuth(): void { GraphHelper::$clientId = $_ENV['CLIENT_ID']; GraphHelper::$clientSecret = $_ENV['CLIENT_SECRET']; GraphHelper::$tenantId = $_ENV['TENANT_ID']; GraphHelper::$tokenContext = new ClientCredentialContext( GraphHelper::$tenantId, GraphHelper::$clientId, GraphHelper::$clientSecret); GraphHelper::$appClient = new GraphServiceClient( GraphHelper::$tokenContext, ['https://graph.microsoft.com/.default']); }
以下列內容取代 main.php 中的空白
initializeGraph
函式。function initializeGraph(): void { GraphHelper::initializeGraphForAppOnlyAuth(); }
此程式代碼會從 .env 檔案載入資訊,並初始化兩個ClientCredentialContext
GraphServiceClient
屬性:對象和物件。 對象 ClientCredentialContext
將用來驗證要求,而 GraphServiceClient
對象將用來呼叫 Microsoft Graph。
測試客戶端認證流程
接下來,新增程式代碼以從 GraphHelper
取得存取令牌。
將下列函式新增至
GraphHelper
類別。public static function getAppOnlyToken(): string { // Create an access token provider to get the token $tokenProvider = new GraphPhpLeagueAccessTokenProvider(GraphHelper::$tokenContext); return $tokenProvider ->getAuthorizationTokenAsync('https://graph.microsoft.com') ->wait(); }
以下列內容取代 main.php 中的空白
displayAccessToken
函式。function displayAccessToken(): void { try { $token = GraphHelper::getAppOnlyToken(); print('App-only token: '.$token.PHP_EOL.PHP_EOL); } catch (Exception $e) { print('Error getting access token: '.$e->getMessage().PHP_EOL.PHP_EOL); } }
建置並執行應用程式。 當系統提示您輸入選項時,請輸入
1
。 應用程式會使用先前在環境變數中設定的驗證資訊,顯示已擷取的存取令牌。$ php main.php PHP Graph Tutorial Please choose one of the following options: 0. Exit 1. Display access token 2. List users 3. Make a Graph call 1 App-only token: eyJ0eXAiOiJKV1QiLCJub25jZSI6IlVDTzRYOWtKYlNLVjVkRzJGenJqd2xvVUcwWS...
提示
僅供驗證和偵錯之用,您可以在 使用 Microsoft 的在線令牌剖析器https://jwt.ms來譯碼僅限應用程式的存取令牌。 如果您在呼叫 Microsoft Graph 時遇到令牌錯誤,這會很有用。 例如,確認
role
令牌中的宣告包含預期的 Microsoft Graph 許可權範圍。
列出使用者
在本節中,您將新增使用僅限應用程式驗證列出 Azure Active Directory 中所有使用者的功能。
將下列程式碼新增至
GraphHelper
類別。public static function getUsers(): Models\UserCollectionResponse { $configuration = new UsersRequestBuilderGetRequestConfiguration(); $configuration->queryParameters = new UsersRequestBuilderGetQueryParameters(); // Only request specific properties $configuration->queryParameters->select = ['displayName','id','mail']; // Sort by display name $configuration->queryParameters->orderby = ['displayName']; // Get at most 25 results $configuration->queryParameters->top = 25; return GraphHelper::$appClient->users()->get($configuration)->wait(); }
以下列內容取代 main.php 中的空白
listUsers
函式。function listUsers(): void { try { $users = GraphHelper::getUsers(); // Output each user's details foreach ($users->getValue() as $user) { print('User: '.$user->getDisplayName().PHP_EOL); print(' ID: '.$user->getId().PHP_EOL); $email = $user->getMail(); $email = isset($email) ? $email : 'NO EMAIL'; print(' Email: '.$email.PHP_EOL); } $nextLink = $users->getOdataNextLink(); $moreAvailable = isset($nextLink) && $nextLink != '' ? 'True' : 'False'; print(PHP_EOL.'More users available? '.$moreAvailable.PHP_EOL.PHP_EOL); } catch (Exception $e) { print(PHP_EOL.'Error getting users: '.$e->getMessage().PHP_EOL.PHP_EOL); } }
執行應用程式、登入,然後選擇選項 2 來列出使用者。
Please choose one of the following options: 0. Exit 1. Display access token 2. List users 3. Make a Graph call 2 User: Adele Vance ID: 05fb57bf-2653-4396-846d-2f210a91d9cf Email: AdeleV@contoso.com User: Alex Wilber ID: a36fe267-a437-4d24-b39e-7344774d606c Email: AlexW@contoso.com User: Allan Deyoung ID: 54cebbaa-2c56-47ec-b878-c8ff309746b0 Email: AllanD@contoso.com User: Bianca Pisani ID: 9a7dcbd0-72f0-48a9-a9fa-03cd46641d49 Email: NO EMAIL User: Brian Johnson (TAILSPIN) ID: a8989e40-be57-4c2e-bf0b-7cdc471e9cc4 Email: BrianJ@contoso.com ... More users available? true
程式代碼說明
請考慮函式中的程序 getUsers
代碼。
- 它會取得使用者的集合。
- 它會使用
queryParameters->select
來要求特定屬性 - 它會使用
queryParameters->top
來限制傳回的用戶數目 - 它會使用
queryParameters->orderby
來排序回應
選擇性:新增您自己的程序代碼
在本節中,您會將自己的 Microsoft Graph 功能新增至應用程式。 這可能是來自 Microsoft Graph 檔 或 Graph 總管的代碼段,或您所建立的程式碼。 此區段為選擇性。
更新應用程式
將下列程式碼新增至
GraphHelper
類別。public static function makeGraphCall(): void { // INSERT YOUR CODE HERE }
以下列內容取代 main.php 中的空白
makeGraphCall
函式。function makeGraphCall(): void { try { GraphHelper::makeGraphCall(); } catch (Exception $e) { print(PHP_EOL.'Error making Graph call'.PHP_EOL.PHP_EOL); } }
選擇 API
在您想要嘗試Microsoft圖形中尋找 API。 例如, 建立事件 API。 您可以使用 API 檔中的其中一個範例,或建立您自己的 API 要求。
設定許可權
請查看所選取 API 參考檔的 [許可權] 區段, 以查看支援哪些驗證方法。 例如,某些 API 不支援僅限應用程式或個人Microsoft帳戶。
- 若要在 API 支援使用者 (委派的) 驗證) 時,使用使用者驗證 (呼叫 API,請參閱 使用者 (委派的) 驗證 教學課程。
- 若要使用僅限應用程式的驗證來呼叫 API (如果 API 支援它) ,請在 Azure AD 系統管理中心新增必要的許可權範圍。
新增您的程序代碼
將您的程式代碼新增至 makeGraphCall
GraphHelper.php 中的函 式。
恭喜!
您已完成 PHP Microsoft Graph 教學課程。 既然您有一個可呼叫 Microsoft Graph 的工作應用程式,您可以實驗並新增新功能。
- 瞭解如何使用 使用者 (委派的) 驗證 搭配 Microsoft Graph PHP SDK。
- 請造訪 Microsoft Graph 概觀 ,以查看您可以使用 Microsoft Graph 存取的所有數據。
PHP 範例
在這個區段有遇到問題嗎? 如果有,請提供意見反應,好讓我們可以改善這個區段。