TwitterOptions 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
Twitter 身份验证处理程序的选项。
public ref class TwitterOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions
public class TwitterOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions
type TwitterOptions = class
inherit RemoteAuthenticationOptions
Public Class TwitterOptions
Inherits RemoteAuthenticationOptions
- 继承
构造函数
TwitterOptions() |
初始化 TwitterOptions 类的新实例。 |
属性
AccessDeniedPath |
获取或设置用户代理重定向到的可选路径(如果用户未批准远程服务器请求的授权要求)。 默认情况下不设置此属性。 在这种情况下,如果远程授权服务器返回access_denied响应,则会引发异常。 (继承自 RemoteAuthenticationOptions) |
Backchannel |
用于与远程标识提供者通信。 (继承自 RemoteAuthenticationOptions) |
BackchannelHttpHandler |
用于与远程标识提供者通信的 HttpMessageHandler。 除非值可以向下转换为 WebRequestHandler,否则不能在设置 BackchannelCertificateValidator 的同时设置此项。 (继承自 RemoteAuthenticationOptions) |
BackchannelTimeout |
获取或设置与远程标识提供者的反向通道通信的超时值(以毫秒为单位)。 (继承自 RemoteAuthenticationOptions) |
CallbackPath |
应用程序的基路径内将返回用户代理的请求路径。 此请求到达时,中间件将处理此请求。 (继承自 RemoteAuthenticationOptions) |
ClaimActions |
声明操作的集合,用于从 json 用户数据中选择值并创建声明。 |
ClaimsIssuer |
获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationSchemeOptions) |
ConsumerKey |
获取或设置用于与 Twitter 通信的使用者密钥。 |
ConsumerSecret |
获取或设置用于对发送到 Twitter 的请求签名的使用者机密。 |
CorrelationCookie |
确定用于在将 Cookie 添加到响应之前创建相关 Cookie 的设置。 (继承自 RemoteAuthenticationOptions) |
DataProtectionProvider |
获取或设置用于保护数据的类型。 (继承自 RemoteAuthenticationOptions) |
Events |
获取或设置 TwitterEvents 用于处理身份验证事件的 。 |
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) |
RetrieveUserDetails |
在身份验证过程中启用检索用户详细信息,包括电子邮件地址。 检索电子邮件地址需要 Twitter 支持部门对每个应用程序的特殊权限。 默认值为 false。 请参阅 https://dev.twitter.com/rest/reference/get/account/verify_credentials。 |
ReturnUrlParameter |
获取或设置参数的名称,该参数用于在触发远程质询到拒绝访问页之前传达用户的原始位置。 仅当显式指定 时, AccessDeniedPath 才使用此属性。 (继承自 RemoteAuthenticationOptions) |
SaveTokens |
定义在成功授权后是否应将访问令牌和刷新令牌存储在 中 AuthenticationProperties 。
默认情况下,此属性设置为 |
SignInScheme |
获取或设置与中间件对应的身份验证方案,该中间件负责在身份验证成功后保留用户标识。 此值通常对应于在 Startup 类中注册的 Cookie 中间件。 如果省略, DefaultSignInScheme 用作回退值。 (继承自 RemoteAuthenticationOptions) |
StateCookie |
确定用于在将 Cookie 添加到响应之前创建状态 Cookie 的设置。 |
StateDataFormat |
获取或设置用于保护处理程序处理的数据的类型。 |
TimeProvider |
用于测试。 (继承自 AuthenticationSchemeOptions) |
方法
Validate() |
添加了验证方法,以确保 Twitter 身份验证中间件的客户密钥和客户机密值不为空 |
Validate() |
检查选项是否有效。 如果情况不正常,应引发异常。 (继承自 RemoteAuthenticationOptions) |
Validate(String) |
检查选项是否对特定方案有效 (继承自 RemoteAuthenticationOptions) |
适用于
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈