使用 Microsoft Graph 和僅限應用程式驗證建置 Python 應用程式
本教學課程會教導您如何建置使用 Microsoft Graph API 的 Python 控制台應用程式,以使用僅限應用程式驗證來存取數據。 對於需要存取組織中所有用戶數據的背景服務或應用程式而言,僅限應用程式驗證是不錯的選擇。
注意
若要瞭解如何使用 Microsoft Graph 代表使用者存取數據,請參閱此 使用者 (委派) 驗證教學課程。
在本教學課程中,您將:
提示
除了遵循本教學課程,您可以下載或複製 GitHub 存放庫 ,並遵循自述檔中的指示來註冊應用程式並設定專案。
必要條件
開始本教學課程之前,您應該已在開發計算機上安裝 Python 和 pip 。
您也應該擁有具有全域管理員角色Microsoft公司或學校帳戶。 如果您沒有Microsoft 365 租使用者,您可能有資格透過 Microsoft 365 開發人員計劃;如需詳細資訊,請參閱 常見問題。 或者,您可以 註冊 1 個月的免費試用版,或購買Microsoft 365 方案。
注意
本教學課程是使用 Python 3.10.4 版和 pip 20.0.2 版所撰寫。 本指南中的步驟可能適用於其他版本,但尚未經過測試。
在入口網站中註冊應用程式
在此練習中,您將在 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 範圍。
建立 Python 控制台應用程式
從建立新的 Python 檔案開始。
建立名為 main.py 的新檔案,並新增下列程序代碼。
print ('Hello world!')
儲存盤案,並使用下列命令來執行檔案。
python3 main.py
如果可以運作,應用程式應該會輸出
Hello world!
。
安裝相依性
繼續之前,請新增一些您稍後將使用的額外相依性。
- 適用於 Python 的 Azure 身分識別用戶端連結庫 ,用來驗證使用者並取得存取令牌。
- Microsoft Graph SDK for Python (預覽) 來呼叫 Microsoft Graph。
在 CLI 中執行下列命令以安裝相依性。
python3 -m pip install azure-identity
python3 -m pip install msgraph-sdk
載入應用程式設定
在本節中,您會將應用程式註冊的詳細數據新增至專案。
在與 config.cfgmain.py 相同的目錄中建立檔案,並新增下列程序代碼。
[azure] clientId = YOUR_CLIENT_ID_HERE clientSecret = YOUR_CLIENT_SECRET_HERE tenantId = YOUR_TENANT_ID_HERE
根據下表更新值。
設定 值 clientId
應用程式註冊的用戶端識別碼 clientSecret
應用程式註冊的客戶端密碼 tenantId
貴組織的租用戶標識碼 提示
您可以選擇性地在名為 config.dev.cfg 的個別檔案中設定這些值。
設計應用程式
在本節中,您將建立簡單的控制台型功能表。
建立名為 graph.py 的新檔案,並將下列程式代碼新增至該檔案。
# Temporary placeholder class Graph: def __init__(self, config): self.settings = config
此程式代碼是佔位元。 您將在下一
Graph
節中實作 類別。開 啟 main.py ,並以下列程式代碼取代其整個內容。
import asyncio import configparser from msgraph.generated.models.o_data_errors.o_data_error import ODataError from graph import Graph async def main(): print('Python Graph App-Only Tutorial\n') # Load settings config = configparser.ConfigParser() config.read(['config.cfg', 'config.dev.cfg']) azure_settings = config['azure'] graph: Graph = Graph(azure_settings) choice = -1 while choice != 0: print('Please choose one of the following options:') print('0. Exit') print('1. Display access token') print('2. List users') print('3. Make a Graph call') try: choice = int(input()) except ValueError: choice = -1 try: if choice == 0: print('Goodbye...') elif choice == 1: await display_access_token(graph) elif choice == 2: await list_users(graph) elif choice == 3: await make_graph_call(graph) else: print('Invalid choice!\n') except ODataError as odata_error: print('Error:') if odata_error.error: print(odata_error.error.code, odata_error.error.message)
在文件尾新增下列佔位符方法。 您將在後續步驟中實作它們。
async def display_access_token(graph: Graph): # TODO return async def list_users(graph: Graph): # TODO return async def make_graph_call(graph: Graph): # TODO return
新增下列程式代碼列,以在檔案尾呼叫
main
。# Run main asyncio.run(main())
這會實作基本功能表,並從命令行讀取用戶的選擇。
新增僅限應用程序驗證
在本節中,您會將僅限應用程式的驗證新增至應用程式。 這是取得必要的 OAuth 存取令牌以呼叫 Microsoft Graph 的必要專案。 在此步驟中,您會將 適用於 Python 的 Azure 身分識別客戶端連結庫 整合到應用程式中,併為 Microsoft Graph SDK for Python (預覽版設定驗證) 。
Azure 身分識別連結庫提供數個實作 OAuth2 令牌流程的 TokenCredential
類別。 Microsoft Graph SDK 會使用這些類別來驗證對 Microsoft Graph 的呼叫。
設定僅限應用程式驗證的 Graph 用戶端
在本節中, ClientSecretCredential
您將使用 類別,使用 用戶端認證流程來要求存取令牌。
開 啟 graph.py ,並以下列程式代碼取代其整個內容。
from configparser import SectionProxy from azure.identity.aio import ClientSecretCredential from msgraph import GraphServiceClient from msgraph.generated.users.users_request_builder import UsersRequestBuilder class Graph: settings: SectionProxy client_credential: ClientSecretCredential app_client: GraphServiceClient def __init__(self, config: SectionProxy): self.settings = config client_id = self.settings['clientId'] tenant_id = self.settings['tenantId'] client_secret = self.settings['clientSecret'] self.client_credential = ClientSecretCredential(tenant_id, client_id, client_secret) self.app_client = GraphServiceClient(self.client_credential) # type: ignore
此程式代碼會宣告兩個
ClientSecretCredential
私用屬性:對象和GraphServiceClient
物件。 函__init__
式會建立 的新實例ClientSecretCredential
,然後使用該實例來建立 的新實GraphServiceClient
例。 每次透過 Microsoft Graphapp_client
進行 API 呼叫時,它都會使用提供的認證來取得存取令牌。將下列函式新增至 graph.py。
async def get_app_only_token(self): graph_scope = 'https://graph.microsoft.com/.default' access_token = await self.client_credential.get_token(graph_scope) return access_token.token
以下列內容取代 main.py 中的空白
display_access_token
函式。async def display_access_token(graph: Graph): token = await graph.get_app_only_token() print('App-only token:', token, '\n')
建置並執行應用程式。 當系統提示您輸入選項時,請輸入
1
。 應用程式會顯示存取令牌。Python Graph App-Only 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 中所有使用者的功能。
將下列函式新增至 graph.py。
async def get_users(self): query_params = UsersRequestBuilder.UsersRequestBuilderGetQueryParameters( # Only request specific properties select = ['displayName', 'id', 'mail'], # Get at most 25 results top = 25, # Sort by display name orderby= ['displayName'] ) request_config = UsersRequestBuilder.UsersRequestBuilderGetRequestConfiguration( query_parameters=query_params ) users = await self.app_client.users.get(request_configuration=request_config) return users
以下列內容取代 main.py 中的空白
list_users
函式。async def list_users(graph: Graph): users_page = await graph.get_users() # Output each users's details if users_page and users_page.value: for user in users_page.value: print('User:', user.display_name) print(' ID:', user.id) print(' Email:', user.mail) # If @odata.nextLink is present more_available = users_page.odata_next_link is not None print('\nMore users available?', more_available, '\n')
執行應用程式,然後選擇選項 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: None User: Brian Johnson (TAILSPIN) ID: a8989e40-be57-4c2e-bf0b-7cdc471e9cc4 Email: BrianJ@contoso.com ... More users available? True
程式代碼說明
請考慮函式中的程序 get_users
代碼。
- 它會取得使用者的集合
- 它會使用
$select
來要求特定屬性 - 它會使用
$top
來限制傳回的用戶數目 - 它會使用
$orderBy
來排序回應
選擇性:新增您自己的程序代碼
在本節中,您會將自己的 Microsoft Graph 功能新增至應用程式。 這可能是來自 Microsoft Graph 檔 或 Graph 總管的代碼段,或您所建立的程式碼。 此區段為選擇性。
更新應用程式
將下列函式新增至 graph.py。
async def make_graph_call(self): # INSERT YOUR CODE HERE return
以下列內容取代 main.py 中的空白
list_inbox
函式。async def make_graph_call(graph: Graph): await graph.make_graph_call()
選擇 API
在您想要嘗試Microsoft圖形中尋找 API。 例如, 建立事件 API。 您可以使用 API 檔中的其中一個範例,或建立您自己的 API 要求。
設定許可權
請查看所選取 API 參考檔的 [許可權] 區段, 以查看支援哪些驗證方法。 例如,某些 API 不支援僅限應用程式或個人Microsoft帳戶。
- 若要在 API 支援使用者 (委派的) 驗證) 時,使用使用者驗證 (呼叫 API,請參閱 使用者 (委派的) 驗證 教學課程。
- 若要使用僅限應用程式的驗證來呼叫 API (如果 API 支援它) ,請在 Azure AD 系統管理中心新增必要的許可權範圍。
新增您的程序代碼
將您的程式代碼複製到 make_graph_call
graph.py 中的函式。
恭喜!
您已完成 Python Microsoft Graph 教學課程。 既然您有一個可呼叫 Microsoft Graph 的工作應用程式,您可以實驗並新增新功能。
- 瞭解如何使用 使用者 (委派的) 驗證 搭配 Microsoft Graph Python SDK。
- 請造訪 Microsoft Graph 概觀 ,以查看您可以使用 Microsoft Graph 存取的所有數據。
Python 範例
在這個區段有遇到問題嗎? 如果有,請提供意見反應,好讓我們可以改善這個區段。