Microsoft Entra ID Windows 帳戶管理員 (WAM) 是一組可讓開發人員整合 Windows 應用程式的 API。 下列參數可以在 Windows 平台上與 MSAL 搭配使用,以利開發可讓使用者透過 Microsoft Entra ID 或 Microsoft 帳戶 (MSA) 登入的應用程式。
Microsoft Entra ID WAM API 參照
| 參數 | 值 | 備註 |
|---|---|---|
authority |
organizations 或特定權杖簽發者 URL。 例如, https://login.partner.microsoftonline.cn 是雲端環境的權杖簽發者 URL。 |
authority 參數會指定 API 的識別提供者和雲端環境。 |
resource |
開發人員取得權杖的 URL,例如 https://www.sharepoint.com |
resource 參數會指定要取得驗證權杖的目標 URL。 |
redirect_uri |
在應用程式成功授權並授與授權碼或存取權杖時,授權伺服器會將使用者傳送過去的位置。 | 備註:通用 Windows 平台 (UWP) 應用程式不支援此參數。 呼叫者必須具有中等完整性層級權限。 請參閱重新導向 URI (回覆 URL) 限制 |
correlationId |
對於每個要求所產生的唯一 GUID,可用來跨資料源聯結要求 |
備註:correlationId 是舊版參數。 其已取代為 WAM API 本身中的屬性。 請參閱 WebTokenRequest.CorrelationId 屬性 (Windows.Security.Authentication.Web.Core) - Windows UWP 應用程式 |
validateAuthority |
布林值;TRUE 或 FALSE。 |
Microsoft Entra ID 外掛程式預設會執行授權單位驗證。 如果應用程式需要停用此驗證,則應該向 FALSE 傳送 validateAuthority 的值。 這在內部部署案例中十分有用。 請參閱 MsalAuthenticationOptions.ValidateAuthority 屬性 |
certificateUsage |
vpn |
此參數用來要求憑證權杖類型。 唯一允許的值為 vpn。 目前,這僅適用於 VPN 案例。 |
certificateUIName |
VPN 憑證的憑證選取 UI 中所顯示的任何字串。 |
certificateUIName 參數會指定字串,而此字串會在選擇 VPN 憑證時顯示於憑證選取使用者介面中。 |
certificateUIDescription |
VPN 憑證的憑證選取 UI 中所顯示的任何字串。 |
certificateUIDescription 參數會指定字串,此字串會在選擇 VPN 憑證時以描述形式顯示於憑證選取使用者介面中。 |
UserPictureEnabled |
True 或 False。 |
指出應用程式是否想要在權杖回應期間接收使用者的圖片。 |
Username |
使用者名稱 | 代表 Microsoft Entra ID 使用者名稱 |
Password |
密碼 | 代表 Microsoft Entra ID 使用者的密碼 |
SamlAssertion |
SAML 權杖 | 以驗證成品形式從第三方 IDP 傳送至 Microsoft Entra ID 的 SAML 權杖 |
SamlAssertionType |
"urn:ietf:params:oauth:grant-type:saml1_1-bearer" 或 "urn:ietf:params:oauth:grant-type:saml2-bearer" |
指定用於驗證的 SAML 權杖類型。 |
LoginHint |
使用者名稱提示 (upn) | 在登入程序期間,提供使用者名稱的提示。 |
msafed |
0 或 1。 |
決定是否允許具有 Microsoft 帳戶的使用者以 Entra 租用戶內的同盟身分識別身分登入。 值 1 會啟用同盟,而 0 會將其停用。 |
discover |
Home |
discover 參數指出是在使用者主雲端的內容中執行權杖要求,而不是裝置所加入的雲端。 |
domain_hint |
相關的網域。 例如,contoso.com |
Microsoft Entra ID 會使用提示以在目錄中尋找網域 注意:如果兩者都以參數的形式傳遞,則網域提示會優先於後援網域 |
fallback_domain |
網域,例如 contoso.com |
fallback_domain 參數是 Microsoft Entra ID 用來在目錄中尋找網域的提示。 其主要用於屬於使用者 UPN 一部分的不可路由使用者網域。 |
client_TokenType |
DeviceAuth |
client_TokenType 參數專門用於要求僅限裝置權杖。 呼叫者需要具有中等完整性層級權限。 |
IsFeatureSupported |
CrossCloudB2B %redirect_uri %TokenBinding。 |
用來檢查目前流程中是否支援功能。 |
prompt |
no_select 或 select_account |
提示參數會控制提示視窗的行為。
no_select 表示未將提示行為控制項附加至提示視窗。
select_account 會顯示帳戶選擇器。 此參數會傳遞至登入服務,以控制帳戶選取行為。 |
minimum_token_lifetime |
時間以毫秒為單位。 | 這是需要要求重新整理權杖且需要捨棄快取權杖的時間 |
telemetry |
MATS |
傳回要求的相關遙測 |
enclave |
sw 指出軟體金鑰、hw 指出硬體金鑰、kg 指出 keyguard 金鑰。 |
enclave 參數會指定要使用的金鑰類型。 |
token_type |
pop 指出擁有權證明權杖shr 指出已簽署的 HTTP 要求權杖 |
token_type 參數會指定要使用的權杖類型。 |
req_cnf |
req_cnf 為 token_type 時 ,會使用 pop 參數。 此欄位包含金鑰的相關資訊,而用戶端想要將此金鑰繫結至擁有權證明的存取權杖。 |
|
refresh_binding |
refresh_binding 參數是即將發行的權杖繫結功能的一部分。 |