OpenIdConnectOptions Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Sestavení:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Balíček:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Zdroj:

OpenIdConnectOptions.cs

Možnosti konfigurace pro 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

Dědičnost

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Konstruktory

OpenIdConnectOptions()

Inicializuje nový OpenIdConnectOptions

Vlastnosti

AccessDeniedPath	Získá nebo nastaví volitelnou cestu, na kterou je přesměrován uživatelský agent, pokud uživatel neschválí požadavek na autorizaci požadovaný vzdáleným serverem. Tato vlastnost není ve výchozím nastavení nastavená. V takovém případě dojde k výjimce, pokud vzdálený autorizační server vrátí odpověď access_denied. (Zděděno od RemoteAuthenticationOptions)
AuthenticationMethod	Získá nebo nastaví metodu použitou k přesměrování uživatelského agenta na zprostředkovatele identity.
Authority	Získá nebo nastaví autoritu k použití při volání OpenIdConnect.
AutomaticRefreshInterval	Získá nebo nastaví, jak často má dojít k automatické aktualizaci metadat.
Backchannel	Používá se ke komunikaci se vzdáleným zprostředkovatelem identity. (Zděděno od RemoteAuthenticationOptions)
BackchannelHttpHandler	HttpMessageHandler slouží ke komunikaci se vzdáleným zprostředkovatelem identity. Tuto hodnotu nelze nastavit současně s backchannelCertificateValidator, pokud nelze hodnotu downcastovat na WebRequestHandler. (Zděděno od RemoteAuthenticationOptions)
BackchannelTimeout	Získá nebo nastaví hodnotu časového limitu v milisekundách pro komunikaci back-channel se vzdáleným zprostředkovatelem identity. (Zděděno od RemoteAuthenticationOptions)
CallbackPath	Cesta požadavku v rámci základní cesty aplikace, kam se vrátí uživatelský agent. Middleware tento požadavek zpracuje, jakmile dorazí. (Zděděno od RemoteAuthenticationOptions)
ClaimActions	Kolekce akcí deklarací identity, která slouží k výběru hodnot z uživatelských dat JSON a vytváření deklarací identity.
ClaimsIssuer	Získá nebo nastaví vystavitele, který by se měl použít pro všechny vytvořené deklarace identity. (Zděděno od AuthenticationSchemeOptions)
ClientId	Získá nebo nastaví "client_id".
ClientSecret	Získá nebo nastaví "client_secret".
Configuration	Konfigurace poskytovaná přímo vývojářem. Pokud zadáte, nebudou použity vlastnosti MetadataAddress a Backchannel. Tyto informace by se neměly během zpracování žádosti aktualizovat.
ConfigurationManager	Zodpovídá za načítání, ukládání do mezipaměti a aktualizaci konfigurace z metadat. Pokud ho nezadáte, vytvoří se pomocí vlastností MetadataAddress a Backchannel.
CorrelationCookie	Určuje nastavení použitá k vytvoření souboru cookie korelace před tím, než se soubor cookie přidá do odpovědi. (Zděděno od RemoteAuthenticationOptions)
DataProtectionProvider	Získá nebo nastaví typ použitý k zabezpečení dat. (Zděděno od RemoteAuthenticationOptions)
DisableTelemetry	Určuje, jestli se má zakázat telemetrie. Když je tato funkce povolená, verze sestavení balíčků Microsoft IdentityModel se odešle vzdálenému zprostředkovateli OpenID Connect jako parametr požadavku autorizace/odhlášení.
Events	Získá nebo nastaví upozorňovat OpenIdConnectEvents při zpracování zpráv OpenIdConnect.
EventsType	Pokud je nastavená, použije se jako typ služby k získání instance Events místo vlastnosti . (Zděděno od AuthenticationSchemeOptions)
ForwardAuthenticate	Pokud je nastaveno, určuje cílové schéma, do kterého by toto schéma mělo předávat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardChallenge	Pokud je nastaveno, určuje cílové schéma, do kterého má toto schéma směrovat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardDefault	Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení forwardAuthenticate/Challenge/Forbid/SignIn/SignOut a pak zkontroluje forwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (Zděděno od AuthenticationSchemeOptions)
ForwardDefaultSelector	Slouží k výběru výchozího schématu pro aktuální požadavek, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení forwardAuthenticate/Challenge/Forbid/SignIn/SignOut a pak zkontroluje forwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (Zděděno od AuthenticationSchemeOptions)
ForwardForbid	Pokud je nastaveno, určuje cílové schéma, do kterého by toto schéma mělo předávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardSignIn	Pokud je nastaveno, určuje cílové schéma, do kterého má toto schéma směrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardSignOut	Pokud je toto nastavení nastavené, určuje cílové schéma, do kterého má toto schéma směrovat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	Logická hodnota k nastavení, jestli má obslužná rutina přejít do koncového bodu s informacemi o uživateli, aby načetla další deklarace identity, nebo ne po vytvoření identity z id_token přijatého z koncového bodu tokenu. Výchozí hodnota je false.
MapInboundClaims	Získá nebo nastaví MapInboundClaims vlastnost výchozí instance JwtSecurityTokenHandler v SecurityTokenValidator a výchozí instance JsonWebTokenHandler v TokenHandler, která se používá při určování, zda mapovat typy deklarací, které jsou extrahovány při ověřování JwtSecurityToken. Pokud je nastavená hodnota true, typ deklarace identity se po překladu pomocí tohoto mapování nastaví na deklaraci identity JSON name. V opačném případě nedojde k žádnému mapování. Výchozí hodnotou je hodnota true.
MaxAge	Získá nebo nastaví "max_age". V případě nastavení se spolu s žádostí o ověření odešle parametr max_age. Pokud zprostředkovatel identity aktivně neověřil uživatele v zadané době, zobrazí se uživateli výzva k opětovnému ověření. Ve výchozím nastavení není zadána žádná max_age.
MetadataAddress	Získá nebo nastaví koncový bod zjišťování pro získání metadat.
NonceCookie	Určuje nastavení, která se použijí k vytvoření souboru cookie typu nonce, než se soubor cookie přidá do odpovědi.
Prompt	Získá nebo nastaví "výzvu".
ProtocolValidator	Získá nebo nastaví hodnotu OpenIdConnectProtocolValidator , která se používá k zajištění, že přijatá id_token je platná pro: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	Získá nebo nastaví minimální čas mezi načtením v případě, že načtení selhalo nebo že byla explicitně požadována aktualizace.
RefreshOnIssuerKeyNotFound	Získá nebo nastaví, pokud by se měla pokusit o aktualizaci metadat po SecurityTokenSignatureKeyNotFoundException. To umožňuje automatické obnovení v případě změny klíče podpisu. Tato možnost je ve výchozím nastavení zapnutá.
RemoteAuthenticationTimeout	Získá nebo nastaví časový limit pro dokončení toku ověřování (ve výchozím nastavení 15 minut). (Zděděno od RemoteAuthenticationOptions)
RemoteSignOutPath	Požadavky přijaté v této cestě způsobí, že obslužná rutina vyvolá SignOut pomocí SignOutScheme.
RequireHttpsMetadata	Získá nebo nastaví, pokud se vyžaduje HTTPS pro adresu metadat nebo autoritu. Výchozí hodnota je true. Tato možnost by měla být zakázaná jenom ve vývojových prostředích.
Resource	Získá nebo nastaví "prostředek".
ResponseMode	Získá nebo nastaví "response_mode".
ResponseType	Získá nebo nastaví "response_type".
ReturnUrlParameter	Získá nebo nastaví název parametru použitého k vyjádření původního umístění uživatele před spuštěním vzdáleného úkolu až na stránku odepření přístupu. Tato vlastnost se používá pouze v AccessDeniedPath případě, že je explicitně zadána. (Zděděno od RemoteAuthenticationOptions)
SaveTokens	Definuje, jestli se mají po úspěšné autorizaci ukládat AuthenticationProperties přístupové a obnovovací tokeny. Tato vlastnost je ve výchozím nastavení nastavená na false , aby se zmenšila velikost konečného ověřovacího souboru cookie. (Zděděno od RemoteAuthenticationOptions)
Scope	Získá seznam oprávnění k vyžádání.
SecurityTokenValidator	Zastaralé. Získá nebo nastaví ISecurityTokenValidator slouží k ověření tokenů identity.
SignedOutCallbackPath	Cesta požadavku v rámci základní cesty aplikace, kde se uživatelský agent vrátí po odhlášení od zprostředkovatele identity. Viz post_logout_redirect_uri z http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	Identifikátor URI, na který bude uživatelský agent přesměrován po odhlášení aplikace od zprostředkovatele identity. Přesměrování proběhne po vyvolání SignedOutCallbackPath.
SignInScheme	Získá nebo nastaví schéma ověřování odpovídající middlewaru zodpovědnému za zachování identity uživatele po úspěšném ověření. Tato hodnota obvykle odpovídá middlewaru cookie zaregistrovaného ve třídě Startup. Pokud je vynechán, DefaultSignInScheme použije se jako záložní hodnota. (Zděděno od RemoteAuthenticationOptions)
SignOutScheme	Schéma ověřování, které se má použít s aplikací SignOut v cestě SignOutPath. Pokud to není nastavené, použije se SignInScheme.
SkipUnrecognizedRequests	Označuje, zda požadavky na CallbackPath mohou být také pro jiné součásti. Pokud je tato možnost povolená, obslužná rutina bude předávat požadavky, které neobsahují odpovědi ověřování OpenIdConnect. Pokud tuto možnost zakážete a nastavíte callbackPath na vyhrazený koncový bod, může to zlepšit zpracování chyb. Tato možnost je ve výchozím nastavení zakázána.
StateDataFormat	Získá nebo nastaví typ používaný k zabezpečení dat zpracovávaných obslužnou rutinou.
StringDataFormat	Získá nebo nastaví typ používaný k zabezpečení řetězců používaných obslužnou rutinou.
TimeProvider	Používá se k testování. (Zděděno od AuthenticationSchemeOptions)
TokenHandler	Získá nebo nastaví TokenHandler slouží k ověření tokenů identity. Použije se místo , SecurityTokenValidator pokud UseSecurityTokenValidator je false.
TokenValidationParameters	Získá nebo nastaví parametry používané k ověření tokenů identity.
UsePkce	Povolí nebo zakáže použití proof key pro standard PKCE (Code Exchange). To platí jenom v ResponseType případě, že je nastavená na Code. Viz třída https://tools.ietf.org/html/rfc7636. Výchozí hodnota je true.
UseSecurityTokenValidator	Získá nebo nastaví, zda se má použít TokenHandler nebo SecurityTokenValidator pro ověřování tokenů identity.
UseTokenLifetime	Označuje, že životnost ověřovací relace (např. soubory cookie) by se měla shodovat s životností ověřovacího tokenu. Pokud token neposkytuje informace o životnosti, použijí se normální životnosti relací. Tato možnost je ve výchozím nastavení zakázána.

Metody

Validate()	Zkontrolujte, jestli jsou možnosti platné. Pokud všechno není v pořádku, měl by vyvolat výjimku.
Validate(String)	Zkontroluje, jestli jsou možnosti platné pro konkrétní schéma. (Zděděno od RemoteAuthenticationOptions)