OpenIdConnectOptions Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Možnosti konfigurace pro OpenIdConnectHandler
public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptionspublic class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptionstype OpenIdConnectOptions = class
inherit RemoteAuthenticationOptionsPublic Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions- Dědičnost
Konstruktory
| OpenIdConnectOptions() |
Inicializuje novou OpenIdConnectOptions |
Vlastnosti
| AccessDeniedPath |
Získá nebo nastaví volitelnou cestu, na kterou je uživatelský agent přesměrován, pokud uživatel neschválí žádost o autorizaci požadovanou vzdáleným serverem. Tato vlastnost není ve výchozím nastavení nastavená. V takovém případě se vyvolá výjimka, pokud server vzdálené autorizace 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. Toto nastavení 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, jakmile přijde. (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ý se má 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, 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 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 |
Označuje, jestli má být telemetrie zakázaná. Pokud je tato funkce povolená, odešle se verze sestavení balíčků Microsoft IdentityModel vzdálenému zprostředkovateli OpenID Connect jako parametr žádosti o autorizaci nebo odhlášení. |
| Events |
Získá nebo nastaví upozornění při OpenIdConnectEvents 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, kterému má toto schéma předávat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Nastavte cíl na aktuální schéma a zakažte předává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, kterému má toto schéma předávat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Nastavte cíl na aktuální schéma a zakažte předává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 forwardDefault. První výsledek, který není null, se použije jako cílové schéma, na které se má přeposlat. (Zděděno od AuthenticationSchemeOptions) |
| ForwardDefaultSelector |
Používá se 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 forwardDefault. První výsledek, který není null, se použije jako cílové schéma, na které se má přeposlat. (Zděděno od AuthenticationSchemeOptions) |
| ForwardForbid |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Nastavte cíl na aktuální schéma a zakažte předává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, kterému má toto schéma předávat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Nastavte cíl na aktuální schéma a zakažte předávání a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions) |
| ForwardSignOut |
Pokud je tato možnost nastavená, určuje cílové schéma, kterému má toto schéma předávat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Nastavte cíl na aktuální schéma a zakažte předává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 s informacemi o uživateli a načíst 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 na výchozí instanci JwtSecurityTokenHandler v SecurityTokenValidator, který se používá při určování, zda mapovat typy deklarací identity, které jsou extrahovány při ověřování JwtSecurityToken. Pokud je tato hodnota nastavená na hodnotu 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í hodnotou je hodnota 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 "id_token" přijato 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 byla aktualizace explicitně požadována. |
| RefreshOnIssuerKeyNotFound |
Získá nebo nastaví, pokud se má aktualizace metadat pokusit securityTokenSignatureKeyNotFoundException. To umožňuje automatické obnovení v případě vrácení 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é na této cestě způsobí, že obslužná rutina vyvolá SignOut pomocí SignOutScheme. |
| RequireHttpsMetadata |
Získá nebo nastaví, pokud je pro adresu nebo autoritu metadat vyžadován protokol HTTPS. Výchozí hodnota je true. Tato možnost by měla být zakázána pouze 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 spuštěním vzdálené výzvy až po stránku odepření přístupu. Tato vlastnost se používá pouze v případě, že AccessDeniedPath je explicitně zadán. (Zděděno od RemoteAuthenticationOptions) |
| SaveTokens |
Definuje, jestli se po úspěšné autorizaci mají ukládat AuthenticationProperties přístupové a obnovovací tokeny.
Tato vlastnost je ve výchozím nastavení nastavena na |
| Scope |
Získá seznam oprávnění k vyžádání. |
| SecurityTokenValidator |
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 agent uživatele vrátí po odhlášení od zprostředkovatele identity. Viz post_logout_redirect_uri od http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout. |
| SignedOutRedirectUri |
Identifikátor URI, do kterého se agent uživatele přesměruje 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 registrovanému ve třídě Startup. Pokud tuto hodnotu vynecháte, 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 SignOutem 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á, předá požadavky, které neobsahují odpovědi ověřování OpenIdConnect. Zakázáním této možnosti a nastavením cesty zpětného volání na vyhrazený koncový bod může být lepší zpracování chyb. Tato možnost je ve výchozím nastavení zakázána. |
| 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. |
| TokenValidationParameters |
Získá nebo nastaví parametry použité k ověření tokenů identity. |
| UsePkce |
Povolí nebo zakáže použití standardu PKCE (Proof Key for Code Exchange).
To platí pouze v případě, že je nastavena ResponseType na Code.
Viz třída https://tools.ietf.org/html/rfc7636.
Výchozí hodnota je |
| 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ázána. |
Metody
| Validate() |
Zkontrolujte, jestli jsou možnosti platné. Pokud nejsou věci v pořádku, měla by vyvolat výjimku. |
| Validate(String) |
Zkontroluje, jestli jsou možnosti platné pro konkrétní schéma. (Zděděno od RemoteAuthenticationOptions) |