Microsoft.Identity.Client 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
Microsoft.Identity.Client是.NET Microsoft 身份验证库(MSAL)的核心命名空间,可通过Microsoft.Identity.Client包获取。 它包含从支持的身份验证提供程序获取令牌所需的所有关键组件。
Installation
dotnet add package Microsoft.Identity.Client
nuget install Microsoft.Identity.Client
使用程序包管理器控制台:
Install-Package Microsoft.Identity.Client
- 打开解决方案资源管理器。
- 右键单击解决方案中的项目。
- 单击“ 管理 NuGet 包...”
- 单击“浏览”选项卡并搜索
Microsoft.Identity.Client。 - 单击包
Microsoft.Identity.Client,然后单击“ 安装”。
Documentation
若要开始,请查看.NET指南Microsoft 身份验证库。
Samples
类
| 名称 | 说明 |
|---|---|
| AbstractAcquireTokenParameterBuilder<T> |
令牌请求的生成器的基类,这些请求尝试基于提供的参数获取令牌。 |
| AbstractApplicationBuilder<T> |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| AbstractClientAppBaseAcquireTokenParameterBuilder<T> |
公共客户端应用程序通用的参数生成器基类和机密客户端应用程序令牌获取操作 |
| AbstractConfidentialClientAcquireTokenParameterBuilder<T> |
机密客户端应用程序令牌请求生成器的基类 |
| AbstractManagedIdentityAcquireTokenParameterBuilder<T> |
托管标识应用程序令牌请求生成器的抽象基类。 |
| AbstractPublicClientAcquireTokenParameterBuilder<T> |
公共客户端应用程序令牌请求生成器的基类 |
| AccountExtensions |
的扩展方法 IAccount |
| AccountId |
特定租户中帐户的标识符。 返回者 IAccount.HomeAccountId |
| AcquireTokenByAuthorizationCodeParameterBuilder |
Builder for AcquireTokenByAuthorizationCode |
| AcquireTokenByIntegratedWindowsAuthParameterBuilder |
Builder for AcquireTokenByIntegratedWindowsAuth |
| AcquireTokenByRefreshTokenParameterBuilder |
方法的参数生成器 AcquireTokenByRefreshToken(IEnumerable<String>, String) 。 请参见https://aka.ms/msal-net-migration-adal2-msal2 |
| AcquireTokenByUserFederatedIdentityCredentialParameterBuilder |
操作的参数生成器 AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String) 。 |
| AcquireTokenByUsernameAndPasswordConfidentialParameterBuilder |
操作的参数生成器 AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) 。 请参见https://aka.ms/msal-net-up |
| AcquireTokenByUsernamePasswordParameterBuilder |
操作的参数生成器 AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) 。 请参见https://aka.ms/msal-net-up |
| AcquireTokenForClientParameterBuilder |
Builder for AcquireTokenForClient(用于客户端凭据流,在守护程序应用程序中)。 请参见https://aka.ms/msal-net-client-credentials |
| AcquireTokenForManagedIdentityParameterBuilder |
Builder for AcquireTokenForManagedIdentity (用于获取托管标识的令牌)。 请参见https://aka.ms/msal-net-managed-identity |
| AcquireTokenInteractiveParameterBuilder |
交互式令牌请求的生成器。 请参见https://aka.ms/msal-net-acquire-token-interactively |
| AcquireTokenOnBehalfOfParameterBuilder |
Builder for AcquireTokenOnBehalfOf (OBO flow) 请参阅 https://aka.ms/msal-net-on-behalf-of |
| AcquireTokenSilentParameterBuilder |
操作的参数生成器 AcquireTokenSilent(IEnumerable<String>, IAccount) 。 请参见https://aka.ms/msal-net-acquiretokensilent |
| AcquireTokenWithDeviceCodeParameterBuilder |
操作的参数生成器 AcquireTokenWithDeviceCode(IEnumerable<String>, Func<DeviceCodeResult,Task>) 。 请参见https://aka.ms/msal-net-device-code-flow |
| ApplicationBase |
用于创建客户端应用程序的接口。 有关详细信息,请参阅 https://aka.ms/msal-net-client-applications。 |
| ApplicationOptions |
包含可从配置文件加载的字符串值的选项对象的基类(例如 JSON 文件,如在 asp.net 配置方案中所示)请参阅另请参阅 https://aka.ms/msal-net-application-configuration 派生类 PublicClientApplicationOptions 和 ConfidentialClientApplicationOptions |
| AssertionRequestOptions |
有关需要生成的客户端断言的信息,请参阅 https://aka.ms/msal-net-client-assertion |
| AuthenticationHeaderParser |
分析的身份验证标头以从 HttpResponseHeaders中检索标头值。 |
| AuthenticationInfoParameters |
Authentication-Info 标头返回的参数。 这允许诸如所有权证明等方案。请参阅 https://www.rfc-editor.org/rfc/rfc7615 |
| AuthenticationResult |
包含一个令牌获取操作的结果或 PublicClientApplication ConfidentialClientApplication。 有关详细信息,请参阅 https://aka.ms/msal-net-authenticationresult |
| AuthenticationResultMetadata |
包含身份验证结果的元数据。 Metrics 用于其他 MSAL 范围的指标。 |
| BaseAbstractAcquireTokenParameterBuilder<T> |
令牌请求的生成器的基类,这些请求尝试基于提供的参数获取令牌。 |
| BaseAbstractApplicationBuilder<T> |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| BaseApplicationOptions |
包含可从配置文件加载的字符串值的选项对象的基类(例如 JSON 文件,如 asp.net 配置方案中所示)请参阅另请参阅 https://aka.ms/msal-net-application-configuration 派生类 ApplicationOptions |
| BrokerOptions |
该类指定跨 OperatingSystems 中转站的选项:通用属性是直接成员平台特定属性(如果存在)是相应选项的一部分 |
| CacheOptions |
MSAL 令牌缓存的选项。 |
| ClientApplicationBase |
包含常见 API 方法和属性的抽象类。 PublicClientApplication和 ConfidentialClientApplication 扩展此类。 有关详细信息,请参阅 https://aka.ms/msal-net-client-applications |
| ClientSignedAssertion |
从 |
| ConfidentialClientApplication |
用于机密客户端应用程序的类(Web 应用、Web API 和守护程序应用程序)。 |
| ConfidentialClientApplicationBuilder |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| ConfidentialClientApplicationOptions |
机密客户端应用程序的配置选项(Web 应用/Web API/守护程序应用)。 请参见https://aka.ms/msal-net/application-configuration |
| DeviceCodeResult |
此对象作为设备代码流的一部分返回,并向用户显示要导航到何处登录的信息,以及需要在该设备上输入哪些设备代码。 请参阅 https://aka.ms/msal-device-code-flow。 |
| EmbeddedWebViewOptions |
用于使用嵌入式 Web 视图的选项。 |
| GetAuthorizationRequestUrlParameterBuilder |
注意:AbstractAcquireTokenParameterBuilder 中的一些方法(例如帐户)在此处没有意义。 是否要创建一个包含所有常用方法的进一步基础,然后创建另一个包含帐户等的基,这些帐户仅用于 AcquireToken? |
| IntuneAppProtectionPolicyRequiredException |
当 Intune 需要应用保护策略时,将引发此异常。 应用可以使用此异常中的信息从移动应用管理 (MAM) SDK 获取所需的注册 ID。 请参见https://aka.ms/msal-net-trueMAM |
| ManagedIdentityApplication |
用于托管标识应用程序的类(在应用服务、虚拟机、Azure Arc、服务Fabric和Cloud Shell等Azure资源上)。 |
| ManagedIdentityApplicationBuilder |
托管标识应用程序的生成器。 |
| ManagedIdentityPopExtensions |
用于在托管标识流中启用 mTLS 所有权证明的扩展方法。 |
| Metrics |
MSAL 范围的指标。 |
| MsalClaimsChallengeException |
此异常指示已从需要解析的终结点返回声明。 这可以通过在下一个身份验证请求中使用它们来实现。 请参阅 条件访问和声明质询。 请参阅 处理多重身份验证(MFA)、条件访问和增量同意。 |
| MsalClientException |
此异常类表示库或设备本地的错误。 MsalServiceException与此相反,表示Azure AD 服务或网络发生的错误。 有关详细信息,请参阅 https://aka.ms/msal-net-exceptions |
| MsalError |
在 MsalException 中作为属性返回的错误代码 |
| MsalException |
在令牌获取期间发生错误时引发的基本异常类型。 有关详细信息,请参阅 https://aka.ms/msal-net-exceptions |
| MsalManagedIdentityException |
此异常类适用于从托管标识源生成的异常。 此类已弃用,将在将来的版本中删除。 请改为捕获 MsalServiceException。 有关详细信息,请参阅 https://aka.ms/msal-net-managed-identity |
| MsalServiceException |
服务返回错误响应或其他网络错误时引发的异常类型。 有关详细信息,请参阅 https://aka.ms/msal-net-exceptions |
| MsalThrottledServiceException |
MSAL 检测到应用程序尝试获取令牌的频率过高时引发的异常类型,原因如下:
此异常的属性与原始异常相同 有关详细信息,请参阅 https://aka.ms/msal-net-throttling |
| MsalThrottledUiRequiredException |
当 MSAL 检测到应用程序尝试获取令牌时引发的异常类型,即使最近引发了令牌 MsalUiRequiredException 。 若要缓解这种情况,遇到这种情况时 MsalUiRequiredException ,应用程序应切换到以交互方式获取令牌。 若要更好地了解引发的原因 MsalUiRequiredException ,请检查 Classification 属性。 此异常的属性与原始异常相同 有关详细信息,请参阅 https://aka.ms/msal-net-throttling |
| MsalUiRequiredException |
此异常类是通知开发人员身份验证成功需要 UI 交互。 调用AcquireTokenSilent(IEnumerable<String>, IAccount)或其替代之一、缓存中不存在令牌或用户需要提供更多内容或基于 Azure AD 策略执行多重身份验证等时,将引发该令牌。 有关详细信息,请参阅 https://aka.ms/msal-net-exceptions |
| OsCapabilitiesExtensions |
扩展方法 |
| PublicClientApplication |
包含常见 API 方法和属性的抽象类。 有关详细信息,请参阅 https://aka.ms/msal-net-client-applications |
| PublicClientApplicationBuilder |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| PublicClientApplicationExtensions |
的扩展性方法 IPublicClientApplication |
| PublicClientApplicationOptions |
公共客户端应用程序(桌面/移动应用)的配置选项。 请参见https://aka.ms/msal-net/application-configuration |
| RegionDetails |
包含使用 MSAL 区域发现(作为 AuthenticationResultMetadata 的一部分发布)时的区域结果。 AuthenticationResultMetadata 用于身份验证结果的其他元数据信息。 |
| SystemWebViewOptions |
将默认 OS 浏览器用作处理交互式身份验证的单独过程的选项。MSAL 将侦听 OS 浏览器完成身份验证,但无法关闭浏览器。 但是,它可以响应 200 OK 消息或 302 重定向,可以在此处配置。 有关详细信息,请参阅 https://aka.ms/msal-net-os-browser |
| TenantProfile |
表示特定租户中的帐户。 同一帐户可以存在于其主租户中,也可以作为其他多个租户中的来宾存在。 访问令牌和 ID 令牌特定于租户,此对象提供有关与帐户关联的所有 ID 令牌的高级信息。 |
| TokenCache |
令牌缓存存储帐户的访问和刷新令牌。此类用于构造函数 PublicClientApplication 和 ConfidentialClientApplication。 对于 ConfidentialClientApplication,使用两个实例,一个用于用户令牌缓存,一个用于应用程序令牌缓存(对于使用客户端凭据流的应用程序)。 |
| TokenCacheExtensions |
ITokenCache 的扩展方法 |
| TokenCacheNotificationArgs |
包含访问缓存的 MSAL 调用使用的参数。 另 ITokenCacheSerializer 请参阅包含自定义缓存序列化的方法。 有关令牌缓存的更多详细信息,请参阅 https://aka.ms/msal-net-web-token-cache |
| TraceTelemetryConfig |
使用 System.Diagnostics.Trace 写入数据的简单 ITelemetryConfig 实现。 |
| UserAssertion |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| WindowsBrokerOptions |
使用 Windows 10 中转站的高级选项。 有关详细信息,请参阅 https://aka.ms/msal-net-wam |
| WwwAuthenticateParameters |
WWW-Authenticate 标头返回的参数。 这允许动态方案,例如声明质询、持续访问评估(CAE)和条件访问(CA)。 请参阅 https://aka.ms/msal-net/wwwAuthenticate。 |
结构
| 名称 | 说明 |
|---|---|
| Prompt |
包含静态成员的结构,可用于指定 AcquireTokenAsync IPublicClientApplication 的交互式重写应如何提示用户。 |
接口
| 名称 | 说明 |
|---|---|
| IAccount |
IAccount 接口表示有关单个帐户的信息。
同一用户可以存在于不同的租户中,也就是说,用户可以有多个帐户。
属性中 |
| IAppConfig |
用于生成公共或机密客户端应用程序的配置属性。 |
| IApplicationBase |
用于创建客户端应用程序的接口。 有关详细信息,请参阅 https://aka.ms/msal-net-client-applications。 |
| IByRefreshToken |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| IByUserFederatedIdentityCredential |
提供一个接口,用于使用用户联合标识凭据(UserFIC)流获取令牌。 |
| IByUsernameAndPassword |
提供用于在机密客户端上使用资源所有者密码授予的显式接口。 |
| IClientApplicationBase |
定义常见 API 方法和属性的接口。 同时 PublicClientApplication 扩展 ConfidentialClientApplication 此类。 有关详细信息,请参阅 https://aka.ms/msal-net-client-applications |
| IConfidentialClientApplication |
表示机密客户端应用程序 - Web 应用、Web API、守护程序应用程序。 |
| ILongRunningWebApi |
Web API 中长时间运行或后台进程的方法。 |
| IManagedIdentityApplication |
用于Azure资源的托管标识应用程序的组件。 |
| IMsalHttpClientFactory |
负责创建 HttpClient 的工厂。 有关详细信息,请参阅 https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing。 |
| IMsalMtlsHttpClientFactory |
负责创建配置为相互 TLS(mTLS)的 HttpClient 实例的工厂。 此工厂旨在用于使用 mTLS 保护与 Azure AD 的通信。 有关 HttpClient 实例的更多详细信息,请参阅 https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-8.0#instancing。 |
| IMsalSFHttpClientFactory |
负责使用自定义服务器证书验证回调创建 HttpClient 的工厂。 这对于使用服务器证书进行服务器证书验证的服务Fabric方案非常有用。有关详细信息,请参阅https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing。 |
| IMsalWsTrustHttpClientFactory |
为联合元数据(MEX)和 WS-Trust 请求创建 HTTP 客户端。 |
| IPublicClientApplication |
表示公共客户端应用程序 - 桌面和移动应用程序。 |
| ITelemetryConfig |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| ITelemetryEventPayload |
表示收集的一系列事件中的单个快照的数据 |
| ITokenCache |
这是实现对缓存操作的公共访问的接口。 使用 CacheV2 时,仅当调用方将缓存保存在其自己的存储中时,才有必要这样做,因为这将提供序列化/反序列化以及在该方案中使用的通知之前/之后。 请参见https://aka.ms/aka.ms/msal-net-token-cache-serialization |
| ITokenCacheSerializer |
此接口将在 TokenCacheNotificationArgs 回调中提供,以启用缓存的序列化/反序列化。 |
枚举
| 名称 | 说明 |
|---|---|
| AadAuthorityAudience |
指定哪些Microsoft帐户可用于使用给定应用程序登录。 请参见https://aka.ms/msal-net-application-configuration |
| AzureCloudInstance |
Installation
使用程序包管理器控制台:
Documentation若要开始,请查看.NET指南Microsoft 身份验证库。 Samples |
| BrokerOptions.OperatingSystems |
支持的 OperatingSystems |
| CacheRefreshReason |
指定在使用 AcquireTokenSilent、AcquireTokenForClient 或 AcquireTokenOnBehalfOf 时从标识提供者提取访问令牌的原因。 |
| LogLevel |
表示 MSAL 中的日志级别。 有关详细信息,请参阅 MSAL 日志记录。 |
| TelemetryAudienceType |
描述遥测受众的类型。 AudienceType |
| TokenSource |
在身份验证结果中指定访问令牌和 ID 令牌的源。 |
| UiRequiredExceptionClassification |
有关原因 MsalUiRequiredException的详细信息,并提示用户在进行交互式身份验证时可以期待的内容。 有关详细信息,请参阅 Understanding MsalUiRequiredException 。 |
委托
| 名称 | 说明 |
|---|---|
| LogCallback |
允许应用程序开发人员使用日志并以自定义方式处理日志的回调委托。 此回调是使用 WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>).
如果 |
| TokenCacheCallback |
令牌获取期间某些令牌缓存交互的通知。 此委托用于提供自定义令牌缓存序列化。 请参见https://aka.ms/aka.ms/msal-net-token-cache-serialization |
注解
贡献
我们赞赏反馈和贡献,以帮助为.NET更好做出Microsoft 身份验证库! 在开始之前,请阅读以下文档:
问题
若要提供库反馈或报告 bug,请在GitHub上提出问题。