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

Zdroj:

OAuthOptions.cs

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 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žadovanou vzdáleným serverem. Tato vlastnost není ve výchozím nastavení nastavena. V tomto případě se vyvolá výjimka, pokud vzdálený autorizační server vrátí odpověď access_denied. (Zděděno od RemoteAuthenticationOptions)
AuthorizationEndpoint	Získá nebo nastaví identifikátor URI, ve kterém bude klient 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 sloužící ke komunikaci se vzdáleným zprostředkovatelem identity. Tuto hodnotu 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 až dorazí. (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ý 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ého zprostředkovatelem.
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 sloužící ke 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, do kterého by toto schéma mělo přesměrovat volání AuthenticateAsync. Například Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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, do kterého by toto schéma mělo přesměrovat volání ChallengeAsync. Příklad Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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 forwardDefaultSelector. První výsledek, který není null, se použije jako cílové schéma pro předávání. (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 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 forwardDefaultSelector. První výsledek, který není null, se použije jako cílové schéma pro předávání. (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ěrovat volání ForbidAsync. Příklad Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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, do kterého by toto schéma mělo přesměrovat volání SignInAsync. Například Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Nastavte cíl na aktuální schéma a zakažte přesměrování a povolte normální zpracování. (Zděděno od AuthenticationSchemeOptions)
ForwardSignOut	Pokud je toto nastavení nastavené, určuje cílové schéma, do kterého by toto schéma mělo přesměrovat volání SignOutAsync. Například Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Nastavte cíl na aktuální schéma a zakažte přesměrová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 aktivací vzdálené výzvy na stránku odepření přístupu. Tato vlastnost se používá pouze v případě, že je explicitně zadána AccessDeniedPath. (Zděděno od RemoteAuthenticationOptions)
SaveTokens	Definuje, zda mají být po úspěšné autorizaci uloženy přístupové a obnovovací tokeny v AuthenticationProperties. Tato vlastnost je nastavena na false ve výchozím nastavení, 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 tuto hodnotu vynecháte, DefaultSignInScheme se použije 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.
TimeProvider	Používá se k testování. (Zděděno od AuthenticationSchemeOptions)
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í ověřovacího klíče pro standard PKCE (Code Exchange). Viz https://tools.ietf.org/html/rfc7636. Výchozí hodnota je false, ale odvozené obslužné rutiny by to měly povolit, pokud ho jejich poskytovatel podporuje.
UserInformationEndpoint	Získá nebo nastaví identifikátor URI middleware získá přístup k získání informací o uživateli. Tato hodnota se nepoužívá ve výchozí implementaci, je určena pro vlastní implementace OnCreatingTicket.

Metody

Validate()	Zkontrolujte, jestli jsou možnosti platné. Pokud věci nejsou v pořádku, měla by vyvolat výjimku.
Validate(String)	Kontroluje, jestli jsou možnosti platné pro určité schéma. (Zděděno od RemoteAuthenticationOptions)