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 uživatelský agent přesměrován, pokud uživatel neschválí požadavek na autorizaci požadovanou vzdáleným serverem. Tato vlastnost není ve výchozím nastavení nastavena. V tomto případě se vyvolá výjimka, 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, která se má použít 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žící ke komunikaci se vzdáleným zprostředkovatelem identity. Tuto hodnotu nelze nastavit současně s backchannelCertificateValidator, pokud hodnota nemůže být downcast na WebRequestHandler. (Zděděno od RemoteAuthenticationOptions)
BackchannelTimeout	Získá nebo nastaví hodnotu časového limitu v milisekundách pro komunikaci back channel s vzdáleným zprostředkovatelem identity. (Zděděno od RemoteAuthenticationOptions)
CallbackPath	Cesta požadavku v rámci základní cesty aplikace, kde se vrátí uživatelský agent. Middleware tento požadavek zpracuje až dorazí. (Zděděno od RemoteAuthenticationOptions)
ClaimActions	Kolekce akcí deklarací identity sloužících k výběru hodnot z uživatelských dat JSON a vytvoř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 je k dispozici, metadataAddress a Backchannel vlastnosti nebudou použity. 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 není k dispozici, vytvoří se jeden 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 má být telemetrie zakázaná. Pokud je tato funkce povolená, verze sestavení balíčků Microsoft IdentityModel se odešle vzdálenému zprostředkovateli OpenID Connect jako parametr žádosti o autorizaci nebo odhlášení.
Events	Získá nebo nastaví OpenIdConnectEvents oznámit při zpracování zpráv OpenIdConnect.
EventsType	Pokud je nastavena, použije se jako typ služby k získání instance Events místo vlastnosti. (Zděděno od AuthenticationSchemeOptions)
ForwardAuthenticate	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions)
ForwardChallenge	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání ChallengeAsync. Příklad Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions)
ForwardDefault	Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by obslužné rutiny ověřování měly ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika předávání nejprve zkontroluje nejsměrnější nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a pak zkontroluje forwardDefaultSelector a pak forwardDefaultSelector. První výsledek, který není null, se použije jako cílové schéma pro předávání. (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 obslužné rutiny ověřování měly ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika předávání nejprve zkontroluje nejsměrnější nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a pak zkontroluje forwardDefaultSelector a pak forwardDefaultSelector. První výsledek, který není null, se použije jako cílové schéma pro předávání. (Zděděno od AuthenticationSchemeOptions)
ForwardForbid	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání ForbidAsync. Příklad Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions)
ForwardSignIn	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions)
ForwardSignOut	Pokud je toto nastavení nastavené, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	Logická hodnota pro nastavení, jestli má obslužná rutina přejít do koncového bodu informací o uživateli, aby po vytvoření identity z id_token koncového bodu tokenu načetla další deklarace identity, nebo ne. 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 název deklarace IDENTITY JSON. V opačném případě nedojde k žádnému mapování. Výchozí hodnota je true.
MaxAge	Získá nebo nastaví 'max_age'. Pokud nastavíte parametr max_age, odešle se žádost o ověření. Pokud zprostředkovatel identity uživatele během zadané doby aktivně neověřil, zobrazí se uživateli výzva k opětovnému ověření. Ve výchozím nastavení není zadán žádný max_age.
MetadataAddress	Získá nebo nastaví koncový bod zjišťování pro získání metadat.
NonceCookie	Určuje nastavení použitá k vytvoření souboru cookie nonce před tím, než se soubor cookie přidá do odpovědi.
Prompt	Získá nebo nastaví výzvu.
ProtocolValidator	Získá nebo nastaví 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ími, v případě, že načtení selhalo nebo že aktualizace byla explicitně požadována.
RefreshOnIssuerKeyNotFound	Získá nebo nastaví, pokud by se měla pokusit aktualizace metadat po SecurityTokenSignatureKeyNotFoundException. To umožňuje automatické obnovení v případě přechodu klíče podpisu. Tato možnost je ve výchozím nastavení povolená.
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 pro adresu nebo autoritu metadat vyžaduje HTTPS. 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 ke sdělení původního umístění uživatele před aktivací vzdálené výzvy na stránku odepření přístupu. Tato vlastnost se používá pouze v případě, že je explicitně zadána AccessDeniedPath. (Zděděno od RemoteAuthenticationOptions)
SaveTokens	Definuje, zda mají být po úspěšné autorizaci uloženy přístupové a obnovovací tokeny v AuthenticationProperties. Tato vlastnost je nastavena na false ve výchozím nastavení, 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 použité 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, do kterého se bude uživatelský agent přesměrovat, až se aplikace odhlásí 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 tuto hodnotu vynecháte, DefaultSignInScheme se použije jako záložní hodnota. (Zděděno od RemoteAuthenticationOptions)
SignOutScheme	Schéma ověřování, které se má použít s SignOut v SignOutPathu. SignInScheme se použije, pokud toto nastavení není nastavené.
SkipUnrecognizedRequests	Označuje, zda požadavky na CallbackPath mohou být také pro jiné součásti. Pokud je obslužná rutina povolená, bude předávat požadavky, které neobsahují odpovědi ověřování OpenIdConnect. Zakázání této možnosti a nastavení metody CallbackPath na vyhrazený koncový bod může poskytovat lepší zpracování chyb. Tato možnost je ve výchozím nastavení zakázaná.
StateDataFormat	Získá nebo nastaví typ použitý k zabezpečení dat zpracovávaných obslužnou rutinou.
StringDataFormat	Získá nebo nastaví typ použitý 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 použité k ověření tokenů identity. Použije se místo SecurityTokenValidator, pokud je UseSecurityTokenValidatorfalse.
TokenValidationParameters	Získá nebo nastaví parametry použité k ověření tokenů identity.
UsePkce	Povolí nebo zakáže použití ověřovacího klíče pro standard PKCE (Code Exchange). To platí pouze v případě, že je ResponseType nastavena na Code. Viz https://tools.ietf.org/html/rfc7636. Výchozí hodnota je true.
UseSecurityTokenValidator	Získá nebo nastaví, zda použít TokenHandler nebo SecurityTokenValidator pro ověřování tokenů identity.
UseTokenLifetime	Označuje, že životnost relace ověřování (např. soubory cookie) by se měla shodovat s ověřovacím tokenem. Pokud token neposkytuje informace o životnosti, použijí se normální životnost relace. Tato možnost je ve výchozím nastavení zakázaná.

Metody

Validate()	Zkontrolujte, jestli jsou možnosti platné. Pokud věci nejsou v pořádku, měla by vyvolat výjimku.
Validate(String)	Kontroluje, jestli jsou možnosti platné pro určité schéma. (Zděděno od RemoteAuthenticationOptions)