OAuthOptions Třída

Definice

Obor názvů:

Microsoft.AspNetCore.Authentication.OAuth

Sestavení:

Microsoft.AspNetCore.Authentication.OAuth.dll

Balíček:

Microsoft.AspNetCore.App.Ref v8.0.0

Možnosti konfigurace OAuth.

public ref class OAuthOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OAuthOptions = class
    inherit RemoteAuthenticationOptions

Public Class OAuthOptions
Inherits RemoteAuthenticationOptions

Dědičnost

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

Odvozené

Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions

Microsoft.AspNetCore.Authentication.Google.GoogleOptions

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountOptions

Konstruktory

OAuthOptions()

Inicializuje novou instanci objektu OAuthOptions.

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žadovaný vzdáleným serverem. Tato vlastnost není ve výchozím nastavení nastavená. V takovém případě dojde k výjimce, pokud vzdálený autorizační server vrátí odpověď access_denied. (Zděděno od RemoteAuthenticationOptions)
AuthorizationEndpoint	Získá nebo nastaví identifikátor URI, kde klient bude přesměrován na ověření.
Backchannel	Používá se ke komunikaci se vzdáleným zprostředkovatelem identity. (Zděděno od RemoteAuthenticationOptions)
BackchannelHttpHandler	HttpMessageHandler použitý ke komunikaci se vzdáleným zprostředkovatelem identity. To nelze nastavit současně s BackchannelCertificateValidator, pokud hodnota můž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 zpětného kanálu 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)
ClaimActions	Kolekce akcí deklarací identity, které slouží k výběru hodnot z uživatelských dat JSON a k 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í ID klienta přiřazeného poskytovatelem.
ClientSecret	Získá nebo nastaví tajný klíč klienta přiřazený 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í OAuthEvents použitý ke zpracování událostí ověřování.
EventsType	Pokud je nastaveno, 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 mělo toto schéma směrovat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (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ěrovávat volání ChallengeAsync. Například Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardDefault	Pokud je tato možnost nastavená, určuje výchozí schéma, do kterého by měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a potom zkontroluje ForwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (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 měly obslužné rutiny ověřování ve výchozím nastavení předávat všechny operace ověřování. Výchozí logika přesměrování nejprve zkontroluje nastavení ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut a potom zkontroluje ForwardDefaultSelector a pak ForwardDefault. První výsledek, který není null, se použije jako cílové schéma, do které se má předat. (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ěrovávat volání ForbidAsync. Například Context.ForbidAsync("ThisScheme") => Context.Forbidasync("ForwardForbidValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardSignIn	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by mělo toto schéma směrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (Zděděno od AuthenticationSchemeOptions)
ForwardSignOut	Pokud je tato možnost nastavená, určuje cílové schéma, do kterého by toto schéma mělo přesměrovávat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Pokud chcete zakázat předávání a povolit normální zpracování, nastavte cíl na aktuální schéma. (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 k vyjádření původního umístění uživatele před spuštěním vzdáleného úkolu až na stránku odepření přístupu. Tato vlastnost se používá pouze v AccessDeniedPath případě, že je explicitně zadána. (Zděděno od RemoteAuthenticationOptions)
SaveTokens	Definuje, jestli se mají po úspěšné autorizaci ukládat AuthenticationProperties přístupové a obnovovací tokeny. Tato vlastnost je ve výchozím nastavení nastavená na false , 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í.
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 je vynechán, DefaultSignInScheme použije se jako záložní hodnota. (Zděděno od RemoteAuthenticationOptions)
StateDataFormat	Získá nebo nastaví typ používaný k zabezpečení dat zpracovávaných middlewarem.
TimeProvider	Používá se k testování. (Zděděno od AuthenticationSchemeOptions)
TokenEndpoint	Získá nebo nastaví identifikátor URI, ke které bude middleware přistupovat k výměně tokenu OAuth.
UsePkce	Povolí nebo zakáže použití proof key pro standard Code Exchange (PKCE). Viz třída https://tools.ietf.org/html/rfc7636. Výchozí hodnota je false , ale odvozené obslužné rutiny by to měly povolit, pokud to jejich zprostředkovatel podporuje.
UserInformationEndpoint	Získá nebo nastaví identifikátor URI, ke které bude middleware přistupovat k získání informací o uživateli. Tato hodnota se nepoužívá ve výchozí implementaci, je určena pro použití ve vlastních implementacích nástroje OnCreatingTicket.

Metody

Validate()	Zkontrolujte, jestli jsou možnosti platné. Pokud to není v pořádku, měl by vyvolat výjimku.
Validate(String)	Zkontroluje, jestli jsou možnosti platné pro konkrétní schéma. (Zděděno od RemoteAuthenticationOptions)