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 nový OpenIdConnectOptions |
OpenIdConnectOptions(String) |
Inicializuje nový OpenIdConnectOptions |
Vlastnosti
AuthenticationMethod |
Získá nebo nastaví metodu použitou k přesměrování uživatelského agenta na zprostředkovatele identity. |
AuthenticationScheme |
Parametr AuthenticationScheme v možnostech odpovídá logickému názvu pro konkrétní schéma ověřování. Pokud chcete v kanálu používat stejný typ middlewaru ověřování více než jednou, můžete přiřadit jinou hodnotu. (Zděděno od AuthenticationOptions) |
Authority |
Získá nebo nastaví autoritu k použití při volání OpenIdConnect. |
AutomaticAuthenticate |
Pokud je hodnota true, middleware ověřování změní požadavek přicházejícího uživatele. Pokud je hodnota false, middleware ověřování poskytne identitu jenom v případě, že to explicitně indikuje AuthenticationScheme. (Zděděno od AuthenticationOptions) |
AutomaticChallenge |
Pokud je hodnota true, měl by ověřovací middleware zpracovat automatické výzvy. Pokud je hodnota false, middleware ověřování změní odpovědi pouze v případě, že to explicitně označí AuthenticationScheme. (Zděděno od AuthenticationOptions) |
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) |
ClaimsIssuer |
Získá nebo nastaví vystavitele, který by se měl 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 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. |
Description |
Další informace o typu ověřování, který je k dispozici 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í upozorňovat IOpenIdConnectEvents při zpracování zpráv OpenIdConnect. |
GetClaimsFromUserInfoEndpoint |
Logická hodnota pro nastavení, jestli má middleware po vytvoření identity z id_token přijatého z koncového bodu tokenu přejít do koncového bodu s informacemi o uživateli, aby načetl další deklarace identity, nebo ne. Výchozí hodnota je false. |
MetadataAddress |
Získá nebo nastaví koncový bod zjišťování pro získání metadat. |
PostLogoutRedirectUri |
Identifikátor URI, do kterého se uživatelský agent vrátí po odhlášení aplikace od zprostředkovatele identity. Přesměrování proběhne po vyvolání SignedOutCallbackPath. |
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 |
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 middleware vyvolá SignOut pomocí SignInScheme. |
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". |
SaveTokens |
Definuje, zda mají být přístupové a obnovovací tokeny uloženy v po AuthenticationProperties úspěšné autorizaci.
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 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. |
SignInScheme |
Získá nebo nastaví schéma ověřování odpovídající middlewaru zodpovědnému za uchová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, SignInScheme 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á, middleware 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 middlewarem. |
StringDataFormat |
Získá nebo nastaví typ používaný k zabezpečení řetězců používaných middlewarem. |
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 ž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. |