OpenIdConnectOptions 类

定义

命名空间:

Microsoft.AspNetCore.Builder

程序集:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

包:

Microsoft.AspNetCore.Authentication.OpenIdConnect v1.1.0

的配置选项OpenIdConnectMiddleware

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions

public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

继承

Object

AuthenticationOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

构造函数

OpenIdConnectOptions()	初始化新的 OpenIdConnectOptions
OpenIdConnectOptions(String)	初始化新的 OpenIdConnectOptions

属性

AuthenticationMethod	获取或设置用于将用户代理重定向到标识提供者的方法。
AuthenticationScheme	选项中的 AuthenticationScheme 对应于特定身份验证方案的逻辑名称。 可以分配其他值，以便在一个管道中多次使用同一个身份验证中间件类型。 (继承自 AuthenticationOptions)
Authority	获取或设置在执行 OpenIdConnect 调用时使用的 Authority。
AutomaticAuthenticate	如果为 true，则身份验证中间件会更改传入的请求用户。 如果为 false，则身份验证中间件仅在 AuthenticationScheme 显式指示时才提供标识。 (继承自 AuthenticationOptions)
AutomaticChallenge	如果为 true，则身份验证中间件应处理自动质询。 如果为 false，则身份验证中间件仅在 AuthenticationScheme 显式指示时更改响应。 (继承自 AuthenticationOptions)
BackchannelHttpHandler	用于与远程标识提供者通信的 HttpMessageHandler。 除非值可以向下转换为 WebRequestHandler，否则不能在设置 BackchannelCertificateValidator 的同时设置此项。 (继承自 RemoteAuthenticationOptions)
BackchannelTimeout	获取或设置与远程标识提供者的反向通道通信的超时值（以毫秒为单位）。 (继承自 RemoteAuthenticationOptions)
CallbackPath	应用程序的基路径内将返回用户代理的请求路径。 此请求到达时，中间件将处理此请求。 (继承自 RemoteAuthenticationOptions)
ClaimsIssuer	获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationOptions)
ClientId	获取或设置“client_id”。
ClientSecret	获取或设置“client_secret”。
Configuration	开发人员直接提供的配置。 如果未提供此项，则不使用 MetadataAddress 和 Backchannel 属性。 处理请求期间不应更新此信息。
ConfigurationManager	负责检索、缓存和刷新元数据中的配置。 如果未提供此项，则会使用 MetadataAddress 和 Backchannel 属性创建一个。
Description	为应用程序提供的有关身份验证类型的附加信息。 (继承自 AuthenticationOptions)
DisplayName	获取或设置用户可以在登录用户界面上显示的文本。 (继承自 RemoteAuthenticationOptions)
Events	获取或设置在 IOpenIdConnectEvents 处理 OpenIdConnect 消息时要通知的 。
GetClaimsFromUserInfoEndpoint	布尔值，用于设置中间件在从令牌终结点接收id_token创建标识后是否应转到用户信息终结点以检索其他声明。 默认值为“false”。
MetadataAddress	获取或设置用于获取元数据的发现终结点
PostLogoutRedirectUri	从标识提供者注销应用程序后，用户代理将返回到的 URI。 重定向将在调用 SignedOutCallbackPath 之后发生。
ProtocolValidator	获取或设置 OpenIdConnectProtocolValidator ，用于确保收到的“id_token”对于以下各项有效： http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshOnIssuerKeyNotFound	获取或设置在发生 SecurityTokenSignatureKeyNotFoundException 后是否应尝试刷新元数据。 如果是，则在发生签名密钥滚动更新的情况下可以执行自动发现。 此项已默认启用。
RemoteAuthenticationTimeout	获取或设置默认情况下完成身份验证流的时间限制 (15 分钟) 。 (继承自 RemoteAuthenticationOptions)
RemoteSignOutPath	在此路径上收到的请求将导致中间件使用 SignInScheme 调用 SignOut。
RequireHttpsMetadata	获取或设置元数据地址或颁发机构是否需要 HTTPS。 默认值为 true。 这只能在开发环境中禁用。
Resource	获取或设置“resource”。
ResponseMode	获取或设置“response_mode”。
ResponseType	获取或设置“response_type”。
SaveTokens	定义在成功授权后是否应将访问令牌和刷新令牌存储在 中 AuthenticationProperties 。 默认情况下，此属性设置为 false 以减小最终身份验证 Cookie 的大小。 (继承自 RemoteAuthenticationOptions)
Scope	获取要请求的权限列表。
SecurityTokenValidator	获取或设置 ISecurityTokenValidator 用于验证标识令牌的 。
SignedOutCallbackPath	应用程序基路径中的请求路径，从标识提供者注销后将返回用户代理。
SignInScheme	获取或设置与中间件对应的身份验证方案，该中间件负责在身份验证成功后保留用户标识。 此值通常对应于在 Startup 类中注册的 Cookie 中间件。 如果省略， SignInScheme 用作回退值。 (继承自 RemoteAuthenticationOptions)
SignOutScheme	用于 SignOutPath 上的 SignOut 的身份验证方案。 如果未设置，将使用 SignInScheme。
SkipUnrecognizedRequests	指示对 CallbackPath 的请求是否也针对其他组件。 如果启用，中间件将通过不包含 OpenIdConnect 身份验证响应的请求传递。 禁用此功能并将 CallbackPath 设置为专用终结点可能会提供更好的错误处理。 此项已默认禁用。
StateDataFormat	获取或设置用于保护由中间件处理的数据的类型。
StringDataFormat	获取或设置用于保护中间件使用的字符串的类型。
SystemClock	仅用于测试目的。 (继承自 AuthenticationOptions)
TokenValidationParameters	获取或设置用于验证标识令牌的参数。
UseTokenLifetime	指示身份验证会话生存期 (例如 cookie) 应与身份验证令牌的生存期匹配。 如果令牌未提供生存期信息，则将使用正常会话的生存期。 此项已默认禁用。