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 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
- Dědičnost
Konstruktory
| OpenIdConnectOptions() |
Inicializuje novou OpenIdConnectOptions |
| OpenIdConnectOptions(String) |
Inicializuje novou OpenIdConnectOptions |
Vlastnosti
| AuthenticationMethod |
Získá nebo nastaví metodu použitou k přesměrování uživatelského agenta na poskytovatele identity. |
| AuthenticationScheme |
AuthenticationScheme v možnostech odpovídá logickému názvu pro konkrétní schéma ověřování. Pro použití stejného typu middlewaru ověřování v kanálu je možné přiřadit jinou hodnotu. (Zděděno od AuthenticationOptions) |
| Authority |
Získá nebo nastaví autoritu, která se má použít při volání OpenIdConnect. |
| AutomaticAuthenticate |
Pokud je hodnota true, middleware ověřování změní požadavek, který uživatel přichází. Pokud je hodnota false, bude middleware ověřování poskytovat pouze identitu, je-li výslovně označena AuthenticationScheme. (Zděděno od AuthenticationOptions) |
| AutomaticChallenge |
Pokud má hodnotu true, musí middleware ověřování zpracovávat automatické výzvy. Pokud je hodnota false, bude middleware ověřování měnit pouze odpovědi, pokud jsou výslovně označeny AuthenticationScheme. (Zděděno od AuthenticationOptions) |
| BackchannelHttpHandler |
HttpMessageHandler, který se používá ke komunikaci se vzdáleným zprostředkovatelem identity. Tuto hodnotu nelze nastavit na stejnou dobu jako 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 se vzdáleným zprostředkovatelem identity. (Zděděno od RemoteAuthenticationOptions) |
| CallbackPath |
Cesta požadavku v základní cestě aplikace, kde se vrátí agent uživatele Middleware tento požadavek zpracuje při doručení. (Zděděno od RemoteAuthenticationOptions) |
| ClaimsIssuer |
Získá nebo nastaví vystavitele, který se má použít pro všechny vytvořené deklarace identity. (Zděděno od AuthenticationOptions) |
| ClientId |
Získá nebo nastaví ' client_id '. |
| ClientSecret |
Získá nebo nastaví ' client_secret '. |
| Configuration |
Konfigurace poskytnutá přímo vývojářem. Pokud je zadaný, pak se nepoužijí vlastnosti MetadataAddress a rechannel. Tyto informace by se neměly aktualizovat během zpracování žádosti. |
| ConfigurationManager |
Zodpovídá za načtení, ukládání do mezipaměti a aktualizaci konfigurace z metadat. Pokud není zadaný, vytvoří se s použitím vlastností MetadataAddress a pro nastavení nového kanálu. |
| Description |
Další informace o typu ověřování, který je zpřístupněn pro aplikaci. (Zděděno od AuthenticationOptions) |
| DisplayName |
Získá nebo nastaví text, který může uživatel zobrazit v uživatelském rozhraní přihlášení. (Zděděno od RemoteAuthenticationOptions) |
| Events |
Získá nebo nastaví IOpenIdConnectEvents Upozornění při zpracování zpráv OpenIdConnect. |
| GetClaimsFromUserInfoEndpoint |
Logická hodnota, která určuje, jestli má middleware přejít na koncový bod informace o uživateli, aby získal 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 (NEPRAVDA). |
| MetadataAddress |
Získá nebo nastaví koncový bod zjišťování pro získání metadat. |
| PostLogoutRedirectUri |
Identifikátor URI, na který se bude agent pro uživatele vracet po odhlášení aplikace od poskytovatele identity. Přesměrování proběhne po vyvolání SignedOutCallbackPath. |
| ProtocolValidator |
Získá nebo nastaví OpenIdConnectProtocolValidator hodnotu, 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 |
| RefreshOnIssuerKeyNotFound |
Získá nebo nastaví, zda se má po SecurityTokenSignatureKeyNotFoundException provést pokus o aktualizaci metadat. To umožňuje automatické obnovení v případě výměny klíče signatury. Tato možnost je ve výchozím nastavení zapnutá. |
| RemoteAuthenticationTimeout |
Získá nebo nastaví časový limit pro dokončení toku ověřování (15 minut ve výchozím nastavení). (Zděděno od RemoteAuthenticationOptions) |
| RemoteSignOutPath |
Požadavky přijaté v této cestě způsobí, že middleware vyvolá přihlášení pomocí SignInScheme. |
| RequireHttpsMetadata |
Získá nebo nastaví, zda je pro adresu nebo autoritu metadat vyžadován protokol HTTPS. Výchozí hodnota je true. To by mělo být zakázáno 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 '. |
| SaveTokens |
Definuje, jestli se mají AuthenticationProperties po úspěšné autorizaci ukládat tokeny přístupu a aktualizace.
Tato vlastnost je ve výchozím nastavení nastavená na |
| Scope |
Získá seznam oprávnění k vyžádání. |
| SecurityTokenValidator |
Získá nebo nastaví ISecurityTokenValidator použitou pro ověřování tokenů identity. |
| SignedOutCallbackPath |
Cesta požadavku v základní cestě aplikace, kde bude uživatelský agent vrácen po odhlášení od poskytovatele identity. |
| SignInScheme |
Získá nebo nastaví schéma ověřování odpovídající middlewaru, který je zodpovědný za zachování identity uživatele po úspěšném ověření. Tato hodnota obvykle odpovídá middlewaru souborů cookie zaregistrovanému ve spouštěcí třídě. Je-li tento parametr vynechán, SignInScheme je použit jako záložní hodnota. (Zděděno od RemoteAuthenticationOptions) |
| SignOutScheme |
Schéma ověřování, které se má použít pro přihlášení na SignOutPath SignInScheme se použije, pokud tato akce není nastavená. |
| SkipUnrecognizedRequests |
Určuje, zda požadavky na CallbackPath mohou být také pro jiné komponenty. Pokud je povoleno, middleware předá požadavky, které neobsahují OpenIdConnect odpovědi ověřování. Zakázáním tohoto nastavení a nastavením CallbackPath na vyhrazený koncový bod může být zajištěno 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 middlewarem. |
| StringDataFormat |
Získá nebo nastaví typ použitý k zabezpečení řetězců, které používá middleware. |
| SystemClock |
Pouze pro účely testování. |
| SystemClock |
Pouze pro účely testování. (Zděděno od AuthenticationOptions) |
| TokenValidationParameters |
Získá nebo nastaví parametry používané k ověření tokenů identity. |
| UseTokenLifetime |
Označuje, že doba platnosti relace ověřování (např. soubory cookie) by měla odpovídat ověřovacímu tokenu. Pokud token neposkytuje informace o životnosti, budou použity normální životnosti relací. Tato možnost je ve výchozím nastavení zakázána. |