OAuthOptions 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
OAuthMiddleware<TOptions> 的配置选项。
public ref class OAuthOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptionspublic class OAuthOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptionstype OAuthOptions = class
inherit RemoteAuthenticationOptionsPublic Class OAuthOptions
Inherits RemoteAuthenticationOptions- 继承
- 派生
构造函数
| OAuthOptions() |
OAuthMiddleware<TOptions> 的配置选项。 |
属性
| AuthenticationScheme |
选项中的 AuthenticationScheme 对应于特定身份验证方案的逻辑名称。 可以分配其他值，以便在一个管道中多次使用同一个身份验证中间件类型。 (继承自 AuthenticationOptions) |
| AuthorizationEndpoint |
获取或设置将重定向客户端以进行身份验证的 URI。 |
| AutomaticAuthenticate |
如果为 true，则身份验证中间件会更改传入的请求用户。 如果为 false，则身份验证中间件仅在 AuthenticationScheme 显式指示时才提供标识。 (继承自 AuthenticationOptions) |
| AutomaticChallenge |
如果为 true，则身份验证中间件应处理自动质询。 如果为 false，则身份验证中间件仅在 AuthenticationScheme 显式指示时更改响应。 (继承自 AuthenticationOptions) |
| BackchannelHttpHandler |
用于与远程标识提供者通信的 HttpMessageHandler。 除非值可以向下转换为 WebRequestHandler，否则不能在设置 BackchannelCertificateValidator 的同时设置此项。 (继承自 RemoteAuthenticationOptions) |
| BackchannelTimeout |
获取或设置与远程标识提供者的反向通道通信的超时值（以毫秒为单位）。 (继承自 RemoteAuthenticationOptions) |
| CallbackPath |
应用程序的基路径内将返回用户代理的请求路径。 此请求到达时，中间件将处理此请求。 (继承自 RemoteAuthenticationOptions) |
| ClaimsIssuer |
获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationOptions) |
| ClientId |
获取或设置提供程序分配的客户端 ID。 |
| ClientSecret |
获取或设置提供程序分配的客户端密码。 |
| Description |
为应用程序提供的有关身份验证类型的附加信息。 (继承自 AuthenticationOptions) |
| DisplayName |
获取或设置用户可以在登录用户界面上显示的文本。 (继承自 RemoteAuthenticationOptions) |
| Events |
获取或设置 IOAuthEvents 用于处理身份验证事件的 。 |
| RemoteAuthenticationTimeout |
获取或设置默认情况下完成身份验证流的时间限制 (15 分钟) 。 (继承自 RemoteAuthenticationOptions) |
| SaveTokens |
定义在成功授权后是否应将访问令牌和刷新令牌存储在 中 AuthenticationProperties 。
默认情况下，此属性设置为 |
| Scope |
获取要请求的权限列表。 |
| SignInScheme |
获取或设置与中间件对应的身份验证方案，该中间件负责在身份验证成功后保留用户标识。 此值通常对应于在 Startup 类中注册的 Cookie 中间件。 如果省略， SignInScheme 用作回退值。 (继承自 RemoteAuthenticationOptions) |
| StateDataFormat |
获取或设置用于保护由中间件处理的数据的类型。 |
| SystemClock |
仅用于测试目的。 |
| SystemClock |
仅用于测试目的。 (继承自 AuthenticationOptions) |
| TokenEndpoint |
获取或设置中间件将访问以交换 OAuth 令牌的 URI。 |
| UserInformationEndpoint |
获取或设置中间件将访问以获取用户信息的 URI。 此值不在默认实现中使用，它用于 IOAuthAuthenticationEvents.Authenticated 或 OAuthAuthenticationHandler.CreateTicketAsync 的自定义实现。 |