OpenIdConnectOptions Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Opzioni di configurazione per 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
- Ereditarietà
Costruttori
OpenIdConnectOptions() |
Inizializza una nuova OpenIdConnectOptions |
Proprietà
AccessDeniedPath |
Ottiene o imposta il percorso facoltativo a cui l'agente utente viene reindirizzato se l'utente non approva la richiesta di autorizzazione richiesta dal server remoto. Questa proprietà non è impostata per impostazione predefinita. In questo caso, viene generata un'eccezione se viene restituita una risposta access_denied dal server di autorizzazione remota. (Ereditato da RemoteAuthenticationOptions) |
AdditionalAuthorizationParameters |
Ottiene i parametri aggiuntivi che verranno inclusi nella richiesta di autorizzazione. |
AuthenticationMethod |
Ottiene o imposta il metodo utilizzato per reindirizzare l'agente utente al provider di identità. |
Authority |
Ottiene o imposta l'autorità da utilizzare durante l'esecuzione di chiamate OpenIdConnect. |
AutomaticRefreshInterval |
Ottiene o imposta la frequenza con cui deve verificarsi un aggiornamento automatico dei metadati. |
Backchannel |
Usato per comunicare con il provider di identità remoto. (Ereditato da RemoteAuthenticationOptions) |
BackchannelHttpHandler |
HttpMessageHandler usato per comunicare con il provider di identità remoto. Questa impostazione non può essere impostata contemporaneamente a BackchannelCertificateValidator, a meno che il valore non possa essere impostato su webRequestHandler. (Ereditato da RemoteAuthenticationOptions) |
BackchannelTimeout |
Ottiene o imposta il valore di timeout in millisecondi per le comunicazioni del canale back con il provider di identità remoto. (Ereditato da RemoteAuthenticationOptions) |
CallbackPath |
Percorso della richiesta all'interno del percorso di base dell'applicazione in cui verrà restituito l'agente utente. Il middleware elaborerà questa richiesta al momento dell'arrivo. (Ereditato da RemoteAuthenticationOptions) |
ClaimActions |
Raccolta di azioni attestazioni usate per selezionare i valori dai dati utente JSON e creare attestazioni. |
ClaimsIssuer |
Ottiene o imposta l'autorità emittente che deve essere utilizzata per tutte le attestazioni create (Ereditato da AuthenticationSchemeOptions) |
ClientId |
Ottiene o imposta l'oggetto 'client_id'. |
ClientSecret |
Ottiene o imposta l'oggetto 'client_secret'. |
Configuration |
Configurazione fornita direttamente dallo sviluppatore. Se specificato, metadataAddress e le proprietà Backchannel non verranno usati. Queste informazioni non devono essere aggiornate durante l'elaborazione delle richieste. |
ConfigurationManager |
Responsabile del recupero, della memorizzazione nella cache e dell'aggiornamento della configurazione dai metadati. Se non specificato, ne verrà creato uno usando le proprietà MetadataAddress e Backchannel. |
CorrelationCookie |
Determina le impostazioni usate per creare il cookie di correlazione prima che il cookie venga aggiunto alla risposta. (Ereditato da RemoteAuthenticationOptions) |
DataProtectionProvider |
Ottiene o imposta il tipo utilizzato per proteggere i dati. (Ereditato da RemoteAuthenticationOptions) |
DisableTelemetry |
Indica se i dati di telemetria devono essere disabilitati. Quando questa funzionalità è abilitata, la versione dell'assembly dei pacchetti Microsoft IdentityModel viene inviata al provider OpenID Connect remoto come parametro di richiesta di autorizzazione/disconnessione. |
Events |
Ottiene o imposta il OpenIdConnectEvents da notificare durante l'elaborazione dei messaggi OpenIdConnect. |
EventsType |
Se impostato, verrà usato come tipo di servizio per ottenere l'istanza events anziché la proprietà . (Ereditato da AuthenticationSchemeOptions) |
ForwardAuthenticate |
Se impostato, specifica lo schema di destinazione a cui questo schema deve inoltrare le chiamate AuthenticateAsync. Ad esempio Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Impostare la destinazione sullo schema corrente per disabilitare l'inoltro e consentire l'elaborazione normale. (Ereditato da AuthenticationSchemeOptions) |
ForwardChallenge |
Se impostato, specifica lo schema di destinazione a cui questo schema deve inoltrare le chiamate ChallengeAsync. Ad esempio Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Impostare la destinazione sullo schema corrente per disabilitare l'inoltro e consentire l'elaborazione normale. (Ereditato da AuthenticationSchemeOptions) |
ForwardDefault |
Se impostato, specifica uno schema predefinito a cui i gestori di autenticazione devono inoltrare per impostazione predefinita tutte le operazioni di autenticazione. La logica di inoltro predefinita verificherà prima l'impostazione ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, seguita dal controllo ForwardDefaultSelector, seguito da ForwardDefault. Il primo risultato non Null verrà usato come schema di destinazione a cui inoltrare. (Ereditato da AuthenticationSchemeOptions) |
ForwardDefaultSelector |
Consente di selezionare uno schema predefinito per la richiesta corrente a cui i gestori di autenticazione devono inoltrare per impostazione predefinita tutte le operazioni di autenticazione. La logica di inoltro predefinita verificherà prima l'impostazione ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, seguita dal controllo ForwardDefaultSelector, seguito da ForwardDefault. Il primo risultato non Null verrà usato come schema di destinazione a cui inoltrare. (Ereditato da AuthenticationSchemeOptions) |
ForwardForbid |
Se impostato, specifica lo schema di destinazione a cui questo schema deve inoltrare le chiamate ForbidAsync. Ad esempio Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Impostare la destinazione sullo schema corrente per disabilitare l'inoltro e consentire l'elaborazione normale. (Ereditato da AuthenticationSchemeOptions) |
ForwardSignIn |
Se impostato, specifica lo schema di destinazione a cui deve inoltrare le chiamate SignInAsync. Ad esempio Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Impostare la destinazione sullo schema corrente per disabilitare l'inoltro e consentire l'elaborazione normale. (Ereditato da AuthenticationSchemeOptions) |
ForwardSignOut |
Se impostato, specifica lo schema di destinazione a cui questo schema deve inoltrare le chiamate SignOutAsync. Ad esempio Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Impostare la destinazione sullo schema corrente per disabilitare l'inoltro e consentire l'elaborazione normale. (Ereditato da AuthenticationSchemeOptions) |
GetClaimsFromUserInfoEndpoint |
Valore booleano per impostare se il gestore deve passare all'endpoint informazioni utente per recuperare attestazioni aggiuntive o meno dopo la creazione di un'identità da id_token ricevuta dall'endpoint del token. Il valore predefinito è 'false'. |
MapInboundClaims |
Ottiene o imposta la proprietà MapInboundClaims nell'istanza predefinita di JwtSecurityTokenHandler in SecurityTokenValidator e nell'istanza predefinita di JsonWebTokenHandler in TokenHandler, che viene utilizzata per determinare se eseguire o meno il mapping dei tipi di attestazione estratti durante la convalida di un JwtSecurityToken. Se questo valore è impostato su true, il tipo di attestazione viene impostato sull'attestazione JSON 'name' dopo la conversione usando questo mapping. In caso contrario, non viene eseguito alcun mapping. Il valore predefinito è true. |
MaxAge |
Ottiene o imposta l'oggetto 'max_age'. Se si imposta il parametro 'max_age' verrà inviato con la richiesta di autenticazione. Se il provider di identità non ha autenticato attivamente l'utente entro il periodo di tempo specificato, all'utente verrà richiesto di ripetere l'autenticazione. Per impostazione predefinita, non viene specificato alcun max_age. |
MetadataAddress |
Ottiene o imposta l'endpoint di individuazione per ottenere i metadati |
NonceCookie |
Determina le impostazioni usate per creare il cookie nonce prima che il cookie venga aggiunto alla risposta. |
Prompt |
Ottiene o imposta la richiesta. |
ProtocolValidator |
Ottiene o imposta il OpenIdConnectProtocolValidator utilizzato per assicurarsi che la ricezione dell'id_token sia valida per: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation |
RefreshInterval |
Ottiene o imposta il tempo minimo tra i recuperamenti, nel caso in cui un recupero non sia riuscito o che sia stato richiesto in modo esplicito un aggiornamento. |
RefreshOnIssuerKeyNotFound |
Ottiene o imposta se un aggiornamento dei metadati deve essere tentato dopo un'eccezione SecurityTokenSignatureKeyNotFoundException. Ciò consente il ripristino automatico in caso di rollover della chiave di firma. Questa opzione è abilitata per impostazione predefinita. |
RemoteAuthenticationTimeout |
Ottiene o imposta il limite di tempo per il completamento del flusso di autenticazione (15 minuti per impostazione predefinita). (Ereditato da RemoteAuthenticationOptions) |
RemoteSignOutPath |
Le richieste ricevute in questo percorso causeranno l'richiamo del gestore signout tramite SignOutScheme. |
RequireHttpsMetadata |
Ottiene o imposta se HTTPS è necessario per l'indirizzo o l'autorità di metadati. Il valore predefinito è true. Questa opzione deve essere disabilitata solo negli ambienti di sviluppo. |
Resource |
Ottiene o imposta la 'risorsa'. |
ResponseMode |
Ottiene o imposta l'response_mode. |
ResponseType |
Ottiene o imposta l'oggetto 'response_type'. |
ReturnUrlParameter |
Ottiene o imposta il nome del parametro utilizzato per comunicare la posizione originale dell'utente prima che la richiesta remota sia stata attivata fino alla pagina di accesso negato. Questa proprietà viene utilizzata solo quando il AccessDeniedPath viene specificato in modo esplicito. (Ereditato da RemoteAuthenticationOptions) |
SaveTokens |
Definisce se i token di accesso e aggiornamento devono essere archiviati nel AuthenticationProperties dopo un'autorizzazione riuscita.
Questa proprietà è impostata su |
Scope |
Ottiene l'elenco di autorizzazioni da richiedere. |
SecurityTokenValidator |
Obsoleti.
Ottiene o imposta il ISecurityTokenValidator utilizzato per convalidare i token di identità. |
SignedOutCallbackPath |
Percorso della richiesta all'interno del percorso di base dell'applicazione in cui l'agente utente verrà restituito dopo la disconnessione dal provider di identità. Vedere post_logout_redirect_uri da http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout. |
SignedOutRedirectUri |
URI in cui l'agente utente verrà reindirizzato a dopo la disconnessione dell'applicazione dal provider di identità. Il reindirizzamento verrà eseguito dopo la chiamata di SignedOutCallbackPath. |
SignInScheme |
Ottiene o imposta lo schema di autenticazione corrispondente al middleware responsabile della persistenza dell'identità dell'utente dopo un'autenticazione riuscita. Questo valore corrisponde in genere a un middleware di cookie registrato nella classe Startup. Se omesso, DefaultSignInScheme viene usato come valore di fallback. (Ereditato da RemoteAuthenticationOptions) |
SignOutScheme |
Schema di autenticazione da usare con SignOut in SignOutPath. SignInScheme verrà usato se non è impostato. |
SkipUnrecognizedRequests |
Indica se anche le richieste a CallbackPath possono essere per altri componenti. Se abilitato, il gestore passerà le richieste che non contengono risposte di autenticazione OpenIdConnect. La disabilitazione di questa impostazione e l'impostazione di CallbackPath su un endpoint dedicato può offrire una migliore gestione degli errori. Questa opzione è disabilitata per impostazione predefinita. |
StateDataFormat |
Ottiene o imposta il tipo utilizzato per proteggere i dati gestiti dal gestore. |
StringDataFormat |
Ottiene o imposta il tipo utilizzato per proteggere le stringhe utilizzate dal gestore. |
TimeProvider |
Usato per i test. (Ereditato da AuthenticationSchemeOptions) |
TokenHandler |
Ottiene o imposta il TokenHandler utilizzato per convalidare i token di identità.
Verrà usato invece di SecurityTokenValidator se UseSecurityTokenValidator è |
TokenValidationParameters |
Ottiene o imposta i parametri usati per convalidare i token di identità. |
UsePkce |
Abilita o disabilita l'uso dello standard PkCE (Proof Key for Code Exchange).
Questo vale solo quando il ResponseType è impostato su Code.
Vedere https://tools.ietf.org/html/rfc7636.
Il valore predefinito è |
UseSecurityTokenValidator |
Ottiene o imposta un valore che indica se utilizzare il TokenHandler o l'SecurityTokenValidator per la convalida dei token di identità. |
UseTokenLifetime |
Indica che la durata della sessione di autenticazione (ad esempio i cookie) deve corrispondere a quella del token di autenticazione. Se il token non fornisce informazioni sulla durata, verranno usate le normali durate delle sessioni. Questa opzione è disabilitata per impostazione predefinita. |
Metodi
Validate() |
Verificare che le opzioni siano valide. Dovrebbe generare un'eccezione se le cose non sono ok. |
Validate(String) |
Verifica che le opzioni siano valide per uno schema specifico (Ereditato da RemoteAuthenticationOptions) |