OAuthOptions Klasa

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Authentication.OAuth

Zestaw:

Microsoft.AspNetCore.Authentication.OAuth.dll

Pakiet:

Microsoft.AspNetCore.App.Ref v8.0.0

Źródło:

OAuthOptions.cs

Opcje konfiguracji 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

Dziedziczenie

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

Pochodne

Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions

Microsoft.AspNetCore.Authentication.Google.GoogleOptions

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountOptions

Konstruktory

OAuthOptions()

Inicjuje nowe wystąpienie OAuthOptions.

Właściwości

AccessDeniedPath	Pobiera lub ustawia opcjonalną ścieżkę, do którą agent użytkownika jest przekierowywany, jeśli użytkownik nie zatwierdzi żądania autoryzacji żądanego przez serwer zdalny. Ta właściwość nie jest domyślnie ustawiona. W takim przypadku zgłaszany jest wyjątek, jeśli zostanie zwrócona access_denied odpowiedź przez zdalny serwer autoryzacji. (Odziedziczone po RemoteAuthenticationOptions)
AuthorizationEndpoint	Pobiera lub ustawia identyfikator URI, w którym klient zostanie przekierowany do uwierzytelniania.
Backchannel	Służy do komunikowania się z dostawcą tożsamości zdalnej. (Odziedziczone po RemoteAuthenticationOptions)
BackchannelHttpHandler	Program HttpMessageHandler używany do komunikowania się ze zdalnym dostawcą tożsamości. Nie można go ustawić w tym samym czasie co BackchannelCertificateValidator, chyba że można obniżyć wartość do elementu WebRequestHandler. (Odziedziczone po RemoteAuthenticationOptions)
BackchannelTimeout	Pobiera lub ustawia wartość limitu czasu w milisekundach dla komunikacji kanału zaplecza z dostawcą tożsamości zdalnej. (Odziedziczone po RemoteAuthenticationOptions)
CallbackPath	Ścieżka żądania w ścieżce podstawowej aplikacji, w której zostanie zwrócony agent użytkownika. Oprogramowanie pośredniczące przetworzy to żądanie po nadejściu. (Odziedziczone po RemoteAuthenticationOptions)
ClaimActions	Kolekcja akcji oświadczeń używanych do wybierania wartości z danych użytkownika json i tworzenia oświadczeń.
ClaimsIssuer	Pobiera lub ustawia wystawcę, który ma być używany dla wszelkich utworzonych oświadczeń (Odziedziczone po AuthenticationSchemeOptions)
ClientId	Pobiera lub ustawia identyfikator klienta przypisanego przez dostawcę.
ClientSecret	Pobiera lub ustawia klucz tajny klienta przypisanego przez dostawcę.
CorrelationCookie	Określa ustawienia używane do tworzenia pliku cookie korelacji przed dodaniu pliku cookie do odpowiedzi. (Odziedziczone po RemoteAuthenticationOptions)
DataProtectionProvider	Pobiera lub ustawia typ używany do zabezpieczania danych. (Odziedziczone po RemoteAuthenticationOptions)
Events	Pobiera lub ustawia OAuthEvents używane do obsługi zdarzeń uwierzytelniania.
EventsType	Jeśli jest ustawiona, zostanie użyta jako typ usługi, aby pobrać wystąpienie Zdarzenia zamiast właściwości. (Odziedziczone po AuthenticationSchemeOptions)
ForwardAuthenticate	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania AuthenticateAsync. Na przykład Context.AuthenticationAsync("ThisScheme") => Context.AuthenticationAsync("ForwardAuthenticateValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardChallenge	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania ChallengeAsync. Na przykład Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardDefault	W przypadku ustawienia określa domyślny schemat, do którego programy obsługi uwierzytelniania powinny domyślnie przekazywać wszystkie operacje uwierzytelniania. Domyślna logika przekazywania najpierw sprawdzi najbardziej specyficzne ustawienie ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, a następnie sprawdź wartość ForwardDefaultSelector, a następnie pozycję ForwardDefaultDefault. Pierwszy wynik bez wartości null będzie używany jako schemat docelowy do przekazania dalej. (Odziedziczone po AuthenticationSchemeOptions)
ForwardDefaultSelector	Służy do wybierania domyślnego schematu dla bieżącego żądania, do którego programy obsługi uwierzytelniania powinny domyślnie przekazywać wszystkie operacje uwierzytelniania. Domyślna logika przekazywania najpierw sprawdzi najbardziej specyficzne ustawienie ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, a następnie sprawdź wartość ForwardDefaultSelector, a następnie pozycję ForwardDefaultDefault. Pierwszy wynik bez wartości null będzie używany jako schemat docelowy do przekazania dalej. (Odziedziczone po AuthenticationSchemeOptions)
ForwardForbid	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania ForbidAsync. Na przykład Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardSignIn	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania signInAsync. Na przykład Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
ForwardSignOut	W przypadku ustawienia określa schemat docelowy, do którego ten schemat powinien przekazywać wywołania signOutAsync. Na przykład Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Ustaw element docelowy na bieżący schemat, aby wyłączyć przekazywanie i zezwolić na normalne przetwarzanie. (Odziedziczone po AuthenticationSchemeOptions)
RemoteAuthenticationTimeout	Pobiera lub ustawia limit czasu ukończenia przepływu uwierzytelniania (domyślnie 15 minut). (Odziedziczone po RemoteAuthenticationOptions)
ReturnUrlParameter	Pobiera lub ustawia nazwę parametru użytego do przekazania oryginalnej lokalizacji użytkownika przed wyzwoleniem zadania zdalnego na stronie odmowy dostępu. Ta właściwość jest używana tylko w przypadku jawnego określenia AccessDeniedPath. (Odziedziczone po RemoteAuthenticationOptions)
SaveTokens	Określa, czy tokeny dostępu i odświeżania powinny być przechowywane w AuthenticationProperties po pomyślnym uwierzytelnieniu. Ta właściwość jest domyślnie ustawiona na false, aby zmniejszyć rozmiar pliku cookie uwierzytelniania końcowego. (Odziedziczone po RemoteAuthenticationOptions)
Scope	Pobiera listę uprawnień do żądania.
SignInScheme	Pobiera lub ustawia schemat uwierzytelniania odpowiadający programowi pośredniczącemu odpowiedzialnemu za utrwalanie tożsamości użytkownika po pomyślnym uwierzytelnieniu. Ta wartość zazwyczaj odpowiada oprogramowaniem pośredniczącym plików cookie zarejestrowanym w klasie Startup. Po pominięciu DefaultSignInScheme jest używana jako wartość rezerwowa. (Odziedziczone po RemoteAuthenticationOptions)
StateDataFormat	Pobiera lub ustawia typ używany do zabezpieczania danych obsługiwanych przez oprogramowanie pośredniczące.
TimeProvider	Służy do testowania. (Odziedziczone po AuthenticationSchemeOptions)
TokenEndpoint	Pobiera lub ustawia identyfikator URI, do których oprogramowanie pośredniczące będzie uzyskiwać dostęp do wymiany tokenu OAuth.
UsePkce	Włącza lub wyłącza korzystanie ze standardu PKCE (Proof Key for Code Exchange). Zobacz https://tools.ietf.org/html/rfc7636. Wartość domyślna to false, ale pochodne programy obsługi powinny włączyć tę opcję, jeśli ich dostawca go obsługuje.
UserInformationEndpoint	Pobiera lub ustawia identyfikator URI, do których oprogramowanie pośredniczące będzie uzyskiwać informacje o użytkowniku. Ta wartość nie jest używana w implementacji domyślnej. Jest ona używana w niestandardowych implementacjach OnCreatingTicket.

Metody

Validate()	Sprawdź, czy opcje są prawidłowe. Jeśli coś nie jest w porządku, należy zgłosić wyjątek.
Validate(String)	Sprawdza, czy opcje są prawidłowe dla określonego schematu (Odziedziczone po RemoteAuthenticationOptions)