OpenIdConnectOptions Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Opcje konfiguracji dla OpenIdConnectMiddleware
public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
- Dziedziczenie
Konstruktory
| OpenIdConnectOptions() |
Inicjuje nową OpenIdConnectOptions |
| OpenIdConnectOptions(String) |
Inicjuje nową OpenIdConnectOptions |
Właściwości
| AuthenticationMethod |
Pobiera lub ustawia metodę używaną do przekierowywania agenta użytkownika do dostawcy tożsamości. |
| AuthenticationScheme |
Schemat uwierzytelniania w opcjach odpowiada nazwie logicznej dla określonego schematu uwierzytelniania. Można przypisać inną wartość, aby używać tego samego typu oprogramowania pośredniczącego uwierzytelniania więcej niż raz w potoku. (Odziedziczone po AuthenticationOptions) |
| Authority |
Pobiera lub ustawia urząd do użycia podczas wykonywania wywołań OpenIdConnect. |
| AutomaticAuthenticate |
Jeśli to prawda, oprogramowanie pośredniczące uwierzytelniania zmienia przychodzącego użytkownika żądania. Jeśli wartość false, oprogramowanie pośredniczące uwierzytelniania będzie dostarczać tożsamość tylko w przypadku jawnego wskazania przez AuthenticationScheme. (Odziedziczone po AuthenticationOptions) |
| AutomaticChallenge |
Jeśli to prawda, oprogramowanie pośredniczące uwierzytelniania powinno obsługiwać automatyczne wyzwanie. Jeśli wartość false, oprogramowanie pośredniczące uwierzytelniania zmieni odpowiedzi tylko wtedy, gdy zostanie jawnie wskazane przez metodę AuthenticationScheme. (Odziedziczone po AuthenticationOptions) |
| 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 wartość może być obniżana 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) |
| ClaimsIssuer |
Pobiera lub ustawia wystawcę, który ma być używany dla wszelkich utworzonych oświadczeń (Odziedziczone po AuthenticationOptions) |
| 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. |
| Description |
Dodatkowe informacje o typie uwierzytelniania, który jest udostępniany aplikacji. (Odziedziczone po AuthenticationOptions) |
| DisplayName |
Pobierz lub ustawia tekst, który użytkownik może wyświetlić w interfejsie użytkownika logowania. (Odziedziczone po RemoteAuthenticationOptions) |
| Events |
Pobiera lub ustawia element IOpenIdConnectEvents do powiadomienia podczas przetwarzania komunikatów OpenIdConnect. |
| GetClaimsFromUserInfoEndpoint |
Wartość logiczna określająca, czy oprogramowanie pośredniczące powinno 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". |
| MetadataAddress |
Pobiera lub ustawia punkt końcowy odnajdywania na potrzeby uzyskiwania metadanych |
| PostLogoutRedirectUri |
Identyfikator URI, w którym agent użytkownika zostanie zwrócony po wylogowaniu aplikacji z dostawcy tożsamości. Przekierowanie nastąpi po wywołaniu metody SignedOutCallbackPath. |
| ProtocolValidator |
Pobiera lub ustawia OpenIdConnectProtocolValidator wartość, która jest używana w celu upewnienia się, że odebrany element "id_token" jest prawidłowy dla: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation |
| RefreshOnIssuerKeyNotFound |
Pobiera lub ustawia, jeśli odświeżanie metadanych powinno zostać podjęta po operacji 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 w tej ścieżce spowodują, że oprogramowanie pośredniczące będzie wywoływać element SignOut przy użyciu programu SignInScheme. |
| RequireHttpsMetadata |
Pobiera lub ustawia, jeśli dla adresu lub urzędu metadanych jest wymagany protokół HTTPS. 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". |
| SaveTokens |
Określa, czy tokeny dostępu i odświeżania powinny być przechowywane w AuthenticationProperties tokenach po pomyślnym uwierzytelnieniu.
Ta właściwość jest domyślnie ustawiona |
| Scope |
Pobiera listę uprawnień do żądania. |
| SecurityTokenValidator |
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. |
| SignInScheme |
Pobiera lub ustawia schemat uwierzytelniania odpowiadający oprogramowania 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 SignInScheme parametr jest używany 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 zostanie ustawiony. |
| SkipUnrecognizedRequests |
Wskazuje, czy żądania do callbackPath mogą być również dla innych składników. Jeśli to ustawienie jest włączone, oprogramowanie pośredniczące będzie przekazywać żą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. Ta opcja jest domyślnie wyłączona. |
| StateDataFormat |
Pobiera lub ustawia typ używany do zabezpieczania danych obsługiwanych przez oprogramowanie pośredniczące. |
| StringDataFormat |
Pobiera lub ustawia typ używany do zabezpieczania ciągów używanych przez oprogramowanie pośredniczące. |
| SystemClock |
Tylko do celów testowych. |
| SystemClock |
Tylko do celów testowych. (Odziedziczone po AuthenticationOptions) |
| TokenValidationParameters |
Pobiera lub ustawia parametry używane do weryfikowania tokenów tożsamości. |
| UseTokenLifetime |
Wskazuje, że okres istnienia sesji uwierzytelniania (np. pliki cookie) powinien odpowiadać okresowi istnienia tokenu uwierzytelniania. Jeśli token nie dostarcza informacji o okresie istnienia, zostaną użyte normalne okresy istnienia sesji. Ta opcja jest domyślnie wyłączona. |