OpenIdConnectOptions Klasa

Definicja

Przestrzeń nazw:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Zestaw:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Pakiet:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Źródło:

OpenIdConnectOptions.cs

Opcje konfiguracji OpenIdConnectHandler

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

public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

Dziedziczenie

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Konstruktory

OpenIdConnectOptions()

Inicjuje nową OpenIdConnectOptions

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)
AuthenticationMethod	Pobiera lub ustawia metodę używaną do przekierowywania agenta użytkownika do dostawcy tożsamości.
Authority	Pobiera lub ustawia urząd do użycia podczas wykonywania wywołań OpenIdConnect.
AutomaticRefreshInterval	Pobiera lub ustawia częstotliwość automatycznego odświeżania metadanych.
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 wartość "client_id".
ClientSecret	Pobiera lub ustawia wartość "client_secret".
Configuration	Konfiguracja dostarczana bezpośrednio przez dewelopera. Jeśli zostanie podana, właściwości MetadataAddress i Backchannel nie będą używane. Te informacje nie powinny być aktualizowane podczas przetwarzania żądań.
ConfigurationManager	Odpowiedzialny za pobieranie, buforowanie i odświeżanie konfiguracji z metadanych. Jeśli nie zostanie podany, zostanie utworzony przy użyciu właściwości MetadataAddress i Backchannel.
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)
DisableTelemetry	Wskazuje, czy dane telemetryczne powinny być wyłączone. Po włączeniu tej funkcji wersja zestawu pakietów Microsoft IdentityModel jest wysyłana do zdalnego dostawcy OpenID Connect jako parametr żądania autoryzacji/wylogowania.
Events	Pobiera lub ustawia OpenIdConnectEvents do powiadamiania podczas przetwarzania komunikatów OpenIdConnect.
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)
GetClaimsFromUserInfoEndpoint	Wartość logiczna określająca, czy program obsługi powinien przejść do punktu końcowego informacji o użytkowniku, aby pobrać dodatkowe oświadczenia, czy nie po utworzeniu tożsamości z id_token odebranych z punktu końcowego tokenu. Wartość domyślna to "false".
MapInboundClaims	Pobiera lub ustawia właściwość MapInboundClaims w domyślnym wystąpieniu JwtSecurityTokenHandler w module SecurityTokenValidator i domyślnym wystąpieniu JsonWebTokenHandler w programie TokenHandler, który jest używany podczas określania, czy mapować typy oświadczeń wyodrębnione podczas sprawdzania poprawności JwtSecurityToken. Jeśli ta wartość ma wartość true, typ oświadczenia jest ustawiony na oświadczenie JSON "name" po przetłumaczeniu przy użyciu tego mapowania. W przeciwnym razie nie ma mapowania. Wartość domyślna to true.
MaxAge	Pobiera lub ustawia wartość "max_age". Jeśli ustawisz parametr "max_age" zostanie wysłany z żądaniem uwierzytelniania. Jeśli dostawca tożsamości nie uwierzytelnił użytkownika aktywnie w określonym czasie, zostanie wyświetlony monit o ponowne uwierzytelnienie. Domyślnie nie określono max_age.
MetadataAddress	Pobiera lub ustawia punkt końcowy odnajdywania na potrzeby uzyskiwania metadanych
NonceCookie	Określa ustawienia używane do utworzenia pliku cookie innego niż plik cookie przed dodaniu pliku cookie do odpowiedzi.
Prompt	Pobiera lub ustawia wartość "prompt".
ProtocolValidator	Pobiera lub ustawia OpenIdConnectProtocolValidator, które są używane do zapewnienia, że odebrane id_token jest prawidłowe dla: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	Pobiera lub ustawia minimalny czas między pobieraniem, w przypadku niepowodzenia pobierania lub jawnego żądania odświeżenia.
RefreshOnIssuerKeyNotFound	Pobiera lub ustawia, czy odświeżanie metadanych powinno zostać podjęta po próbie securityTokenSignatureKeyNotFoundException. Umożliwia to automatyczne odzyskiwanie w przypadku przerzucania klucza podpisu. Ta opcja jest domyślnie włączona.
RemoteAuthenticationTimeout	Pobiera lub ustawia limit czasu ukończenia przepływu uwierzytelniania (domyślnie 15 minut). (Odziedziczone po RemoteAuthenticationOptions)
RemoteSignOutPath	Żądania odebrane na tej ścieżce spowodują, że program obsługi wywoła wyloguj się przy użyciu elementu SignOutScheme.
RequireHttpsMetadata	Pobiera lub ustawia, jeśli protokół HTTPS jest wymagany dla adresu metadanych lub urzędu. Wartość domyślna to true. Powinno to być wyłączone tylko w środowiskach deweloperskich.
Resource	Pobiera lub ustawia "zasób".
ResponseMode	Pobiera lub ustawia wartość "response_mode".
ResponseType	Pobiera lub ustawia wartość "response_type".
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.
SecurityTokenValidator	Przestarzałe. Pobiera lub ustawia ISecurityTokenValidator używane do weryfikowania tokenów tożsamości.
SignedOutCallbackPath	Ścieżka żądania w ścieżce podstawowej aplikacji, w której agent użytkownika zostanie zwrócony po wylogowaniu się od dostawcy tożsamości. Zobacz post_logout_redirect_uri z http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	Identyfikator URI, do którego zostanie przekierowany agent użytkownika po wylogowaniu aplikacji z dostawcy tożsamości. Przekierowanie nastąpi po wywołaniu elementu SignedOutCallbackPath.
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)
SignOutScheme	Schemat uwierzytelniania, który ma być używany z funkcją SignOutPath. Parametr SignInScheme będzie używany, jeśli nie został ustawiony.
SkipUnrecognizedRequests	Wskazuje, czy żądania do callbackPath mogą być również dla innych składników. Jeśli program obsługi zostanie włączony, przekaże żądania, które nie zawierają odpowiedzi uwierzytelniania OpenIdConnect. Wyłączenie tej funkcji i ustawienie metody CallbackPath do dedykowanego punktu końcowego może zapewnić lepszą obsługę błędów. Jest to domyślnie wyłączone.
StateDataFormat	Pobiera lub ustawia typ używany do zabezpieczania danych obsługiwanych przez program obsługi.
StringDataFormat	Pobiera lub ustawia typ używany do zabezpieczania ciągów używanych przez program obsługi.
TimeProvider	Służy do testowania. (Odziedziczone po AuthenticationSchemeOptions)
TokenHandler	Pobiera lub ustawia TokenHandler używane do weryfikowania tokenów tożsamości. Będzie on używany zamiast SecurityTokenValidator, jeśli UseSecurityTokenValidator jest false.
TokenValidationParameters	Pobiera lub ustawia parametry używane do weryfikowania tokenów tożsamości.
UsePkce	Włącza lub wyłącza korzystanie ze standardu PKCE (Proof Key for Code Exchange). Ma to zastosowanie tylko wtedy, gdy ResponseType jest ustawiona na wartość Code. Zobacz https://tools.ietf.org/html/rfc7636. Wartość domyślna to true.
UseSecurityTokenValidator	Pobiera lub ustawia, czy używać TokenHandler, czy SecurityTokenValidator do sprawdzania poprawności tokenów tożsamości.
UseTokenLifetime	Wskazuje, że okres istnienia sesji uwierzytelniania (np. pliki cookie) powinien być zgodny z tokenem uwierzytelniania. Jeśli token nie dostarcza informacji o okresie istnienia, zostaną użyte normalne okresy istnienia sesji. Jest to domyślnie wyłączone.

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)