Microsoft Entra ID Windows 帐户管理器 (WAM) API 参考
Microsoft Entra ID Windows 帐户管理器 (WAM) 是一组 API,使开发人员能够集成 Windows 应用程序。 可以在 Windows 平台上将以下参数与 MSAL 配合使用,从而促进允许用户通过 Microsoft Entra ID 或 Microsoft 帐户 (MSA) 登录的应用程序的开发。
Microsoft Entra ID WAM API 参考
参数 | 值 | 说明 |
---|---|---|
authority |
organizations 或特定的令牌颁发者 URL。 例如, https://login.partner.microsoftonline.cn 是 Mooncake 云环境的令牌颁发者 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 插件执行颁发机构验证。 如果应用程序需要禁用此验证,则应为 validateAuthority 发送 FALSE 值。 这在本地方案中非常有用。 请参阅 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 令牌 | SAML 令牌作为身份验证项目从第三方 IDP 发送到 Microsoft Entra ID |
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 使用提示在目录中查找域 注意:如果 ADAL 将域提示和回退域作为参数传递,则域提示优先于回退域 |
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 指示密钥保护密钥。 |
enclave 参数指定要使用的密钥的类型。 |
token_type |
pop 指示所有权证明令牌 shr 指示已签名的 HTTP 请求令牌 |
token_type 参数指定要使用的令牌的类型。 |
req_cnf |
当 token_type 为 pop 时,将使用 req_cnf 参数。 此字段包含有关客户端希望绑定到访问令牌以进行所有权证明的密钥的信息。 |
|
refresh_binding |
refresh_binding 参数是即将发布的令牌绑定功能的一部分。 |