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。 此屬性不能與 BackchannelCertificateValidator 同時設定，除非此值可以向下轉型為 WebRequestHandler。 (繼承來源 RemoteAuthenticationOptions)
BackchannelTimeout	取得或設定與遠端識別提供者進行反向通道通訊的毫秒逾時值。 (繼承來源 RemoteAuthenticationOptions)
CallbackPath	應用程式的基本路徑中將傳回 user-agent 的要求路徑。 中介軟體將會在此要求送達時予以處理。 (繼承來源 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) 應該符合驗證權杖的 Cookie。 如果權杖未提供存留期資訊，則會使用正常工作階段存留期。 此選項預設為停用狀態。