OpenIdConnectOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.OpenIdConnect

組件:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

套件:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

的組態選項OpenIdConnectHandler

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

public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

繼承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

建構函式

OpenIdConnectOptions()

初始化新的 OpenIdConnectOptions

屬性

AccessDeniedPath	取得或設定當使用者未核准遠端伺服器所要求的授權要求時，使用者代理程式會重新導向至的選擇性路徑。 此屬性預設不會設定。 在此情況下，如果遠端授權伺服器傳回access_denied回應，就會擲回例外狀況。 (繼承來源 RemoteAuthenticationOptions)
AuthenticationMethod	取得或設定用來將使用者代理程式重新導向至識別提供者的方法。
Authority	取得或設定呼叫 OpenIdConnect 時使用的 Authority。
AutomaticRefreshInterval	取得或設定自動中繼資料重新整理應該發生的頻率。
Backchannel	用來與遠端識別提供者通訊。 (繼承來源 RemoteAuthenticationOptions)
BackchannelHttpHandler	用來與遠端識別提供者通訊的 HttpMessageHandler。 此屬性不能與 BackchannelCertificateValidator 同時設定，除非此值可以向下轉型為 WebRequestHandler。 (繼承來源 RemoteAuthenticationOptions)
BackchannelTimeout	取得或設定與遠端識別提供者進行反向通道通訊的毫秒逾時值。 (繼承來源 RemoteAuthenticationOptions)
CallbackPath	應用程式的基本路徑中將傳回 user-agent 的要求路徑。 中介軟體將會在此要求送達時予以處理。 (繼承來源 RemoteAuthenticationOptions)
ClaimActions	用來從 json 使用者資料中選取值的宣告動作集合，並建立宣告。
ClaimsIssuer	取得或設定應該用於任何已建立宣告的簽發者 (繼承來源 AuthenticationSchemeOptions)
ClientId	取得或設定 'client_id'。
ClientSecret	取得或設定 'client_secret'。
Configuration	由開發人員直接提供的設定。 如果提供，則不會使用 MetadataAddress 和 Backchannel 屬性。 在要求處理期間不應該更新此資訊。
ConfigurationManager	負責從中繼資料擷取、快取和重新整理設定。 如果未提供，則會使用 MetadataAddress 和 Backchannel 屬性來建立一個。
CorrelationCookie	決定在 Cookie 新增至回應之前，用來建立相互關聯 Cookie 的設定。 (繼承來源 RemoteAuthenticationOptions)
DataProtectionProvider	取得或設定用來保護資料的型別。 (繼承來源 RemoteAuthenticationOptions)
DisableTelemetry	指出是否應該停用遙測。 啟用此功能時，Microsoft IdentityModel 套件的元件版本會以授權/登出要求參數的形式傳送至遠端 OpenID Connect 提供者。
Events	取得或設定在 OpenIdConnectEvents 處理 OpenIdConnect 訊息時要通知的 。
EventsType	如果設定，則會當做服務類型來取得 Events 實例，而不是 屬性。 (繼承來源 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)
GetClaimsFromUserInfoEndpoint	布林值，設定處理常式是否應該移至使用者資訊端點，以擷取其他宣告，而不是在從權杖端點接收id_token識別之後擷取。 預設值為 'false'。
MapInboundClaims	取得或設定 MapInboundClaims SecurityTokenValidator 中預設實例 JwtSecurityTokenHandler 上的 屬性，以及 TokenHandler 中的 預設實例 JsonWebTokenHandler ，在判斷驗證 時是否要對應所擷取的宣告類型。 JwtSecurityToken 如果此值設定為 true，則宣告類型會在使用此對應進行翻譯之後，設定為 JSON 宣告 'name'。 否則，不會發生任何對應。 預設值為 true。
MaxAge	取得或設定 'max_age'。 如果設定 'max_age' 參數，將會與驗證要求一起傳送。 如果識別提供者未在指定的時間長度內主動驗證使用者，系統會提示使用者重新驗證。 預設不會指定任何max_age。
MetadataAddress	取得或設定探索端點以取得中繼資料
NonceCookie	決定在 Cookie 新增至回應之前，用來建立 nonce Cookie 的設定。
Prompt	取得或設定 'prompt'。
ProtocolValidator	取得或設定 OpenIdConnectProtocolValidator ，用來確保收到的 'id_token' 是每個有效的： http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	取得或設定擷取、擷取失敗或明確要求重新整理之間的最短時間。
RefreshOnIssuerKeyNotFound	取得或設定在發生 SecurityTokenSignatureKeyNotFoundException 之後是否應該嘗試重新整理中繼資料。 這允許在簽章金鑰變換時自動復原。 此選項預設為啟用狀態。
RemoteAuthenticationTimeout	取得或設定預設) 完成驗證流程的時間限制 (15 分鐘。 (繼承來源 RemoteAuthenticationOptions)
RemoteSignOutPath	在此路徑上收到的要求會導致處理常式使用 SignOutScheme 叫用 SignOut。
RequireHttpsMetadata	取得或設定中繼資料位址或授權單位是否需要 HTTPS。 預設值是 true。 這應該只在開發環境中停用。
Resource	取得或設定 'resource'。
ResponseMode	取得或設定 'response_mode'。
ResponseType	取得或設定 'response_type'。
ReturnUrlParameter	取得或設定參數的名稱，用來在遠端挑戰觸發到拒絕存取頁面之前傳達使用者的原始位置。 只有在明確指定 時 AccessDeniedPath ，才會使用這個屬性。 (繼承來源 RemoteAuthenticationOptions)
SaveTokens	定義存取權和重新整理權杖是否應在 成功授權之後儲存在 中 AuthenticationProperties 。 此屬性預設會設定為 false ，以減少最終驗證 Cookie 的大小。 (繼承來源 RemoteAuthenticationOptions)
Scope	取得要要求的許可權清單。
SecurityTokenValidator	已淘汰. 取得或設定 ISecurityTokenValidator 用來驗證身分識別權杖的 。
SignedOutCallbackPath	從識別提供者登出之後，應用程式基底路徑內的要求路徑會傳回使用者代理程式。 請參閱 從 http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout post_logout_redirect_uri。
SignedOutRedirectUri	從識別提供者登出應用程式之後，使用者代理程式會重新導向至的 URI。 重新導向會在叫用 SignedOutCallbackPath 之後發生。
SignInScheme	取得或設定與負責在成功驗證之後保存使用者身分識別的中介軟體對應的驗證配置。 這個值通常會對應到 Startup 類別中註冊的 Cookie 中介軟體。 省略時， DefaultSignInScheme 會當做後援值使用。 (繼承來源 RemoteAuthenticationOptions)
SignOutScheme	與 SignOutPath 上的 SignOut 搭配使用的驗證配置。 如果未設定，則會使用 SignInScheme。
SkipUnrecognizedRequests	指出 CallbackPath 的要求是否也適用于其他元件。 如果啟用，處理常式會透過不包含 OpenIdConnect 驗證回應的要求傳遞。 停用此選項並將 CallbackPath 設定為專用端點可能會提供更好的錯誤處理。 此選項預設為停用狀態。
StateDataFormat	取得或設定用來保護處理常式所處理之資料的型別。
StringDataFormat	取得或設定用來保護處理常式所使用字串的型別。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)
TokenHandler	取得或設定 TokenHandler 用來驗證身分識別權杖的 。 如果 UseSecurityTokenValidator 是 false ，則會使用這個值， SecurityTokenValidator 而不是 。
TokenValidationParameters	取得或設定用來驗證身分識別權杖的參數。
UsePkce	啟用或停用使用程式碼交換證明金鑰 (PKCE) 標準。 這只適用于 設定為 Code 時 ResponseType 。 請參閱 https://tools.ietf.org/html/rfc7636。 預設值是 true。
UseSecurityTokenValidator	取得或設定是否要使用 TokenHandler 或 SecurityTokenValidator 來驗證身分識別權杖。
UseTokenLifetime	表示驗證會話存留期 (例如 cookie) 應該符合驗證權杖的 Cookie。 如果權杖未提供存留期資訊，則會使用正常工作階段存留期。 此選項預設為停用狀態。

方法

Validate()	檢查選項是否有效。 如果專案不正常，應該擲回例外狀況。
Validate(String)	檢查選項是否適用于特定配置 (繼承來源 RemoteAuthenticationOptions)