OAuthOptions 类

定义

命名空间:

Microsoft.AspNetCore.Authentication.OAuth

程序集:

Microsoft.AspNetCore.Authentication.OAuth.dll

包:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

OAuthOptions.cs

配置选项 OAuth。

public ref class OAuthOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OAuthOptions = class
    inherit RemoteAuthenticationOptions

Public Class OAuthOptions
Inherits RemoteAuthenticationOptions

继承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

派生

Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions

Microsoft.AspNetCore.Authentication.Google.GoogleOptions

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountOptions

构造函数

OAuthOptions()

初始化 OAuthOptions的新实例。

属性

AccessDeniedPath	获取或设置用户代理重定向到的可选路径（如果用户未批准远程服务器请求的授权要求）。 默认情况下不设置此属性。 在这种情况下，如果远程授权服务器返回access_denied响应，则会引发异常。 (继承自 RemoteAuthenticationOptions)
AuthorizationEndpoint	获取或设置客户端将重定向到进行身份验证的 URI。
Backchannel	用于与远程标识提供者通信。 (继承自 RemoteAuthenticationOptions)
BackchannelHttpHandler	用于与远程标识提供者通信的 HttpMessageHandler。 这不能与 BackchannelCertificateValidator 同时设置，除非该值可以向下转换为 WebRequestHandler。 (继承自 RemoteAuthenticationOptions)
BackchannelTimeout	获取或设置与远程标识提供者的反向通道通信的超时值（以毫秒为单位）。 (继承自 RemoteAuthenticationOptions)
CallbackPath	将返回用户代理的应用程序基路径中的请求路径。 当中间件到达时，中间件将处理此请求。 (继承自 RemoteAuthenticationOptions)
ClaimActions	声明操作的集合，用于从 json 用户数据中选择值并创建声明。
ClaimsIssuer	获取或设置应用于所创建的任何声明的颁发者 (继承自 AuthenticationSchemeOptions)
ClientId	获取或设置提供程序分配的客户端 ID。
ClientSecret	获取或设置提供程序分配的客户端密码。
CorrelationCookie	确定用于在将 Cookie 添加到响应之前创建相关 Cookie 的设置。 (继承自 RemoteAuthenticationOptions)
DataProtectionProvider	获取或设置用于保护数据的类型。 (继承自 RemoteAuthenticationOptions)
Events	获取或设置用于处理身份验证事件的 OAuthEvents。
EventsType	如果已设置，将用作服务类型来获取事件实例而不是属性。 (继承自 AuthenticationSchemeOptions)
ForwardAuthenticate	如果已设置，则指定此方案应将 AuthenticateAsync 调用转发到的目标方案。 例如 Context.AuthenticateAsync（“ThisScheme”） => Context.AuthenticateAsync（“ForwardAuthenticateValue”）：将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardChallenge	如果设置，则指定此方案应将 ChallengeAsync 调用转发到的目标方案。 例如 Context.ChallengeAsync（“ThisScheme”） => Context.ChallengeAsync（“ForwardChallengeValue”）：将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardDefault	如果设置，则指定一个默认方案，身份验证处理程序应默认将所有身份验证操作转发到该方案。 默认转发逻辑将首先检查最具体的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 设置，然后检查 ForwardDefaultSelector，后跟 ForwardDefault。 第一个非 null 结果将用作要转发的目标方案。 (继承自 AuthenticationSchemeOptions)
ForwardDefaultSelector	用于为当前请求选择默认方案，身份验证处理程序应默认将所有身份验证操作转发到该方案。 默认转发逻辑将首先检查最具体的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 设置，然后检查 ForwardDefaultSelector，后跟 ForwardDefault。 第一个非 null 结果将用作要转发的目标方案。 (继承自 AuthenticationSchemeOptions)
ForwardForbid	如果已设置，则指定此方案应将 ForbidAsync 调用转发到的目标方案。 例如 Context.ForbidAsync（“ThisScheme”） => Context.ForbidAsync（“ForwardForbidValue”）;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardSignIn	如果已设置，则指定此方案应将 SignInAsync 调用转发到的目标方案。 例如 Context.SignInAsync（“ThisScheme”） => Context.SignInAsync（“ForwardSignInValue”）;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardSignOut	如果已设置，则指定此方案应将 SignOutAsync 调用转发到的目标方案。 例如 Context.SignOutAsync（“ThisScheme”） => Context.SignOutAsync（“ForwardSignOutValue”）;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
RemoteAuthenticationTimeout	获取或设置完成身份验证流的时间限制（默认情况下为 15 分钟）。 (继承自 RemoteAuthenticationOptions)
ReturnUrlParameter	获取或设置参数的名称，该参数用于在远程质询触发到访问被拒绝页面之前传达用户的原始位置。 仅当显式指定 AccessDeniedPath 时，才使用此属性。 (继承自 RemoteAuthenticationOptions)
SaveTokens	定义在成功授权后是否应将访问和刷新令牌存储在 AuthenticationProperties 中。 默认情况下，此属性设置为 false 以减少最终身份验证 Cookie 的大小。 (继承自 RemoteAuthenticationOptions)
Scope	获取要请求的权限列表。
SignInScheme	获取或设置与负责在成功身份验证后保留用户标识的中间件对应的身份验证方案。 此值通常对应于 Startup 类中注册的 Cookie 中间件。 省略时，DefaultSignInScheme 用作回退值。 (继承自 RemoteAuthenticationOptions)
StateDataFormat	获取或设置用于保护中间件处理的数据的类型。
TimeProvider	用于测试。 (继承自 AuthenticationSchemeOptions)
TokenEndpoint	获取或设置中间件将访问以交换 OAuth 令牌的 URI。
UsePkce	启用或禁用对代码交换（PKCE）标准的证明密钥的使用。 请参阅 https://tools.ietf.org/html/rfc7636。 默认值是 false 但派生处理程序应在提供程序支持的情况下启用此值。
UserInformationEndpoint	获取或设置中间件将访问以获取用户信息的 URI。 此值未在默认实现中使用，用于 OnCreatingTicket的自定义实现。

方法

Validate()	检查选项是否有效。 如果情况不正常，应引发异常。
Validate(String)	检查选项是否对特定方案有效 (继承自 RemoteAuthenticationOptions)