OAuthOptions 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 OAuth.
public ref class OAuthOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptionspublic class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptionstype OAuthOptions = class
inherit RemoteAuthenticationOptionsPublic Class OAuthOptions
Inherits RemoteAuthenticationOptions- Dědičnost
- Odvozené
Konstruktory
| OAuthOptions() |
Inicializuje novou instanci OAuthOptions. |
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) |
| AuthorizationEndpoint |
Získá nebo nastaví identifikátor URI, ve kterém se klient přesměruje na ověření. |
| 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í ID klienta přiřazeného poskytovatelem. |
| ClientSecret |
Získá nebo nastaví tajný klíč klienta přiřazeného poskytovatelem. |
| 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) |
| Events |
Získá nebo nastaví použitou OAuthEvents k zpracování událostí ověřování. |
| 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) |
| 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) |
| 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í. |
| 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) |
| StateDataFormat |
Získá nebo nastaví typ použitý k zabezpečení dat zpracovávaných middlewarem. |
| TokenEndpoint |
Získá nebo nastaví identifikátor URI, který middleware získá přístup k výměně tokenu OAuth. |
| UsePkce |
Povolí nebo zakáže použití standardu PKCE (Proof Key for Code Exchange). Viz třída https://tools.ietf.org/html/rfc7636.
Výchozí hodnota je |
| UserInformationEndpoint |
Získá nebo nastaví identifikátor URI middleware, který získá přístup k informacím o uživateli. Tato hodnota se nepoužívá ve výchozí implementaci, je určena pro použití ve vlastních implementacích OnCreatingTicket. |
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) |