Microsoft.Identity.Client Spazio dei nomi
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.
Microsoft.Identity.Clientè lo spazio dei nomi principale per il Libreria di Autenticazione Microsoft (MSAL) per .NET, disponibile tramite il Microsoft.Identity.Client pacchetto. Contiene tutti i componenti chiave necessari per acquisire un token dai provider di autenticazione supportati.
Installazione
Uso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
dotnet add package Microsoft.Identity.Client
Uso dell'interfaccia della riga di comando nuGet:
nuget install Microsoft.Identity.Client
Uso della console Gestione pacchetti:
Install-Package Microsoft.Identity.Client
Uso di Visual Studio:
- Aprire il Esplora soluzioni.
- Fare clic con il pulsante destro del mouse su un progetto all'interno della soluzione.
- Fare clic su Gestisci pacchetti NuGet...
- Fare clic sulla scheda Sfoglia e cercare
Microsoft.Identity.Client. - Fare clic sul
Microsoft.Identity.Clientpacchetto e fare clic su Installa.
Documentazione
Per iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET.
Esempi
Fare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser.
Classi
| Nome | Descrizione |
|---|---|
| AbstractAcquireTokenParameterBuilder<T> |
Classe di base per i generatori di richieste di token, che tentano di acquisire un token in base ai parametri forniti. |
| AbstractApplicationBuilder<T> |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| AbstractClientAppBaseAcquireTokenParameterBuilder<T> |
Classe di base per i generatori di parametri comuni alle operazioni di acquisizione di token dell'applicazione client pubblica e di token applicazione client riservati |
| AbstractConfidentialClientAcquireTokenParameterBuilder<T> |
Classe di base per i generatori di richieste di token dell'applicazione client riservati |
| AbstractManagedIdentityAcquireTokenParameterBuilder<T> |
Classe base astratta per i generatori di richieste di token dell'applicazione dell'identità gestita. |
| AbstractPublicClientAcquireTokenParameterBuilder<T> |
Classe di base per i generatori di richieste di token dell'applicazione client pubblica |
| AccountExtensions |
Metodi di estensione per IAccount |
| AccountId |
Identificatore di un account in un tenant specifico. Restituito da IAccount.HomeAccountId |
| AcquireTokenByAuthorizationCodeParameterBuilder |
Generatore per AcquireTokenByAuthorizationCode |
| AcquireTokenByIntegratedWindowsAuthParameterBuilder |
Generatore per AcquireTokenByIntegratedWindowsAuth |
| AcquireTokenByRefreshTokenParameterBuilder |
Generatore di parametri per il AcquireTokenByRefreshToken(IEnumerable<String>, String) metodo . Fare riferimento a https://aka.ms/msal-net-migration-adal2-msal2 |
| AcquireTokenByUserFederatedIdentityCredentialParameterBuilder |
Generatore di parametri per l'operazione AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String) . |
| AcquireTokenByUsernameAndPasswordConfidentialParameterBuilder |
Generatore di parametri per l'operazione AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) . Fare riferimento a https://aka.ms/msal-net-up |
| AcquireTokenByUsernamePasswordParameterBuilder |
Generatore di parametri per l'operazione AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) . Fare riferimento a https://aka.ms/msal-net-up |
| AcquireTokenForClientParameterBuilder |
Generatore per AcquireTokenForClient (usato nei flussi di credenziali client, nelle applicazioni daemon). Fare riferimento a https://aka.ms/msal-net-client-credentials |
| AcquireTokenForManagedIdentityParameterBuilder |
Generatore per AcquireTokenForManagedIdentity (usato per ottenere il token per le identità gestite). Fare riferimento a https://aka.ms/msal-net-managed-identity |
| AcquireTokenInteractiveParameterBuilder |
Generatore per una richiesta di token interattivo. Fare riferimento a https://aka.ms/msal-net-acquire-token-interactively |
| AcquireTokenOnBehalfOfParameterBuilder |
Generatore per AcquireTokenOnBehalfOf (flusso OBO) Vedere https://aka.ms/msal-net-on-behalf-of |
| AcquireTokenSilentParameterBuilder |
Generatore di parametri per l'operazione AcquireTokenSilent(IEnumerable<String>, IAccount) . Fare riferimento a https://aka.ms/msal-net-acquiretokensilent |
| AcquireTokenWithDeviceCodeParameterBuilder |
Generatore di parametri per l'operazione AcquireTokenWithDeviceCode(IEnumerable<String>, Func<DeviceCodeResult,Task>) . Fare riferimento a https://aka.ms/msal-net-device-code-flow |
| ApplicationBase |
Interfaccia usata per la creazione di applicazioni client. Per informazioni dettagliate, vedere https://aka.ms/msal-net-client-applications. |
| ApplicationOptions |
Classe di base per gli oggetti options con valori stringa caricabili da un file di configurazione (ad esempio un file JSON, come in uno scenario di configurazione asp.net) Vedere https://aka.ms/msal-net-application-configuration anche classi PublicClientApplicationOptions derivate e ConfidentialClientApplicationOptions |
| AssertionRequestOptions |
Informazioni sull'asserzione client che devono essere generate, vedere https://aka.ms/msal-net-client-assertion |
| AuthenticationHeaderParser |
Intestazioni di autenticazione analizzate per recuperare i valori di intestazione da HttpResponseHeaders. |
| AuthenticationInfoParameters |
Parametri restituiti dall'intestazione Authentication-Info. Ciò consente scenari come proof-of-possession e così via. Vedere https://www.rfc-editor.org/rfc/rfc7615 |
| AuthenticationResult |
Contiene i risultati di un'operazione di acquisizione di token in PublicClientApplication o ConfidentialClientApplication. Per informazioni dettagliate, vedere https://aka.ms/msal-net-authenticationresult |
| AuthenticationResultMetadata |
Contiene i metadati del risultato dell'autenticazione. Metrics per altre metriche a livello di MSAL. |
| BaseAbstractAcquireTokenParameterBuilder<T> |
Classe di base per i generatori di richieste di token, che tentano di acquisire un token in base ai parametri forniti. |
| BaseAbstractApplicationBuilder<T> |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| BaseApplicationOptions |
Classe di base per gli oggetti options con valori stringa caricabili da un file di configurazione (ad esempio un file JSON, come in uno scenario di configurazione asp.net) Vedere https://aka.ms/msal-net-application-configuration anche classi derivate ApplicationOptions |
| BrokerOptions |
La classe specifica le opzioni per broker in OperatingSystems Le proprietà comuni sono proprietà specifiche della piattaforma dei membri diretti (se esistenti) fanno parte delle opzioni corrispondenti |
| CacheOptions |
Opzioni per le cache dei token MSAL. |
| ClientApplicationBase |
Classe astratta contenente i metodi e le proprietà comuni dell'API. Sia PublicClientApplication che ConfidentialClientApplication estendono questa classe. Per informazioni dettagliate, vedere https://aka.ms/msal-net-client-applications |
| ClientSignedAssertion |
Contenitore restituito da |
| ConfidentialClientApplication |
Classe da usare per applicazioni client riservate (app Web, API Web e applicazioni daemon). |
| ConfidentialClientApplicationBuilder |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| ConfidentialClientApplicationOptions |
Opzioni di configurazione per un'applicazione client riservata (app Web/API Web/app daemon). Fare riferimento a https://aka.ms/msal-net/application-configuration |
| DeviceCodeResult |
Questo oggetto viene restituito come parte del flusso del codice del dispositivo e contiene informazioni che devono essere visualizzate all'utente su dove passare all'account di accesso e sul codice del dispositivo da immettere nel dispositivo. Vedete https://aka.ms/msal-device-code-flow. |
| EmbeddedWebViewOptions |
Opzioni per l'uso della visualizzazione Web incorporata. |
| GetAuthorizationRequestUrlParameterBuilder |
NOTA: alcuni dei metodi in AbstractAcquireTokenParameterBuilder (ad esempio, account) non hanno senso qui. Si vuole creare un'ulteriore base contenente TUTTI i metodi comuni e quindi avere un altro account incluso e così via che vengono usati solo per AcquireToken? |
| IntuneAppProtectionPolicyRequiredException |
Questa eccezione viene generata quando Intune richiede criteri di protezione delle app. Le informazioni contenute in questa eccezione possono essere usate dall'app per ottenere l'ID di registrazione richiesto da Mobile App Management (MAM) SDK. Fare riferimento a https://aka.ms/msal-net-trueMAM |
| ManagedIdentityApplication |
Classe da usare per le applicazioni di gestione delle identità (in Azure risorse come Servizi app, Macchine virtuali, Azure Arc, Fabric del servizio e Cloud Shell). |
| ManagedIdentityApplicationBuilder |
Generatore per applicazioni di identità gestite. |
| ManagedIdentityPopExtensions |
Metodi di estensione per abilitare mTLS Proof-of-Possession nei flussi di identità gestiti. |
| Metrics |
Metriche a livello di MSAL. |
| MsalClaimsChallengeException |
Questa eccezione indica che le attestazioni sono state restituite dall'endpoint che devono essere risolte. A tale scopo, è possibile usarli nella richiesta di autenticazione successiva. Vedere Problemi di accesso condizionale e attestazioni. Vedere Gestione dell'autenticazione a più fattori (MFA), dell'accesso condizionale e del consenso incrementale. |
| MsalClientException |
Questa classe di eccezione rappresenta gli errori locali per la libreria o il dispositivo. Contrariamente al MsalServiceException fatto che rappresentano gli errori che si verificano dal servizio ad Azure o dalla rete. Per informazioni dettagliate, vedi https://aka.ms/msal-net-exceptions |
| MsalError |
Codice di errore restituito come proprietà in MsalException |
| MsalException |
Tipo di eccezione di base generato quando si verifica un errore durante l'acquisizione del token. Per informazioni dettagliate, vedi https://aka.ms/msal-net-exceptions |
| MsalManagedIdentityException |
Questa classe di eccezione riguarda le eccezioni generate dalle origini di identità gestite. Questa classe è deprecata e verrà rimossa in una versione futura. Rilevare invece MsalServiceException. Per informazioni dettagliate, vedi https://aka.ms/msal-net-managed-identity |
| MsalServiceException |
Tipo di eccezione generato quando il servizio restituisce una risposta di errore o altri errori di rete. Per informazioni dettagliate, vedi https://aka.ms/msal-net-exceptions |
| MsalThrottledServiceException |
Tipo di eccezione generato quando MSAL rileva che un'applicazione sta tentando di acquisire un token troppo spesso, in seguito a quanto segue:
Le proprietà di questa eccezione sono identiche all'eccezione originale Per altri dettagli, vedere https://aka.ms/msal-net-throttling |
| MsalThrottledUiRequiredException |
Tipo di eccezione generato quando MSAL rileva che un'applicazione sta tentando di acquisire un token anche se è MsalUiRequiredException stato generato di recente. Per attenuare questo problema, quando viene rilevato un MsalUiRequiredException oggetto , l'applicazione deve passare all'acquisizione di un token in modo interattivo. Per comprendere meglio il motivo per cui MsalUiRequiredException è stato generato , controllare la Classification proprietà . Le proprietà di questa eccezione sono identiche all'eccezione originale Per altri dettagli, vedere https://aka.ms/msal-net-throttling |
| MsalUiRequiredException |
Questa classe di eccezione consiste nell'informare gli sviluppatori che l'interazione dell'interfaccia utente è necessaria per il successo dell'autenticazione. Viene generata quando si chiama AcquireTokenSilent(IEnumerable<String>, IAccount) o si esegue una delle sostituzioni e quando il token non esiste nella cache oppure l'utente deve fornire più contenuti o eseguire l'autenticazione a più fattori in base ai criteri di Active Directory Azure e così via. Per informazioni dettagliate, vedi https://aka.ms/msal-net-exceptions |
| OsCapabilitiesExtensions |
Metodi di estensione |
| PublicClientApplication |
Classe astratta contenente i metodi e le proprietà comuni dell'API. Per informazioni dettagliate, vedere https://aka.ms/msal-net-client-applications |
| PublicClientApplicationBuilder |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| PublicClientApplicationExtensions |
Metodi di estendibilità per IPublicClientApplication |
| PublicClientApplicationOptions |
Opzioni di configurazione per un'applicazione client pubblica (desktop/app per dispositivi mobili). Fare riferimento a https://aka.ms/msal-net/application-configuration |
| RegionDetails |
Contiene il risultato dell'area quando viene usata l'individuazione dell'area MSAL, pubblicata come parte di AuthenticationResultMetadata. AuthenticationResultMetadata per informazioni aggiuntive sui metadati del risultato dell'autenticazione. |
| SystemWebViewOptions |
Opzioni per l'uso del browser del sistema operativo predefinito come processo separato per gestire l'autenticazione interattiva. MSAL sarà in ascolto del completamento dell'autenticazione del browser del sistema operativo, ma non può chiudere il browser. Può tuttavia rispondere con un messaggio 200 OK o un reindirizzamento 302, che può essere configurato qui. Per altri dettagli, vedere https://aka.ms/msal-net-os-browser |
| TenantProfile |
Rappresenta un account in un tenant specifico. Lo stesso account può esistere nel tenant principale e anche come guest in più tenant. I token di accesso e i token ID sono specifici del tenant e questo oggetto fornisce informazioni di alto livello su tutti i token ID associati all'account. |
| TokenCache |
Cache dei token che archivia i token di accesso e di aggiornamento per gli account Questa classe viene usata nei costruttori di PublicClientApplication e ConfidentialClientApplication. Nel caso di ConfidentialClientApplication, vengono usate due istanze, una per la cache dei token utente e una per la cache dei token dell'applicazione (nel caso delle applicazioni che usano i flussi di credenziali client). |
| TokenCacheExtensions |
Metodi di estensione per ITokenCache |
| TokenCacheNotificationArgs |
Contiene i parametri utilizzati dalla chiamata MSAL che accede alla cache. Vedere anche ITokenCacheSerializer che contiene metodi per personalizzare la serializzazione della cache. Per altri dettagli sulla cache dei token, vedere https://aka.ms/msal-net-web-token-cache |
| TraceTelemetryConfig |
Implementazione semplice ITelemetryConfig che scrive i dati usando System.Diagnostics.Trace. |
| UserAssertion |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| WindowsBrokerOptions |
Opzioni avanzate per l'uso del broker Windows 10. Per altri dettagli, vedere https://aka.ms/msal-net-wam |
| WwwAuthenticateParameters |
Parametri restituiti dall'intestazione WWW-Authenticate. Ciò consente scenari dinamici, ad esempio la richiesta di attestazioni, la valutazione dell'accesso continuo (CAE) e l'accesso condizionale (CA). Vedete https://aka.ms/msal-net/wwwAuthenticate. |
Struct
| Nome | Descrizione |
|---|---|
| Prompt |
Struttura contenente membri statici che è possibile usare per specificare il modo in cui gli override interattivi di AcquireTokenAsync in IPublicClientApplication devono richiedere all'utente. |
Interfacce
| Nome | Descrizione |
|---|---|
| IAccount |
L'interfaccia IAccount rappresenta informazioni su un singolo account.
Lo stesso utente può essere presente in tenant diversi, ovvero un utente può avere più account.
Un |
| IAppConfig |
Proprietà di configurazione usate per compilare un'applicazione client pubblica o riservata. |
| IApplicationBase |
Interfaccia usata per la creazione di applicazioni client. Per informazioni dettagliate, vedere https://aka.ms/msal-net-client-applications. |
| IByRefreshToken |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| IByUserFederatedIdentityCredential |
Fornisce un'interfaccia per l'acquisizione di token tramite il flusso User Federated Identity Credential (UserFIC). |
| IByUsernameAndPassword |
Fornisce un'interfaccia esplicita per l'uso della concessione della password del proprietario della risorsa nel client riservato. |
| IClientApplicationBase |
Interfaccia che definisce i metodi e le proprietà comuni dell'API. Entrambe PublicClientApplication e ConfidentialClientApplication estendono questa classe. Per informazioni dettagliate, vedere https://aka.ms/msal-net-client-applications |
| IConfidentialClientApplication |
Rappresenta le applicazioni client riservate: app Web, API Web, applicazioni daemon. |
| ILongRunningWebApi |
Metodi per processi in background o a esecuzione prolungata nelle API Web. |
| IManagedIdentityApplication |
Componente da usare con applicazioni di identità gestite per Azure risorse. |
| IMsalHttpClientFactory |
Factory responsabile della creazione di HttpClient. Per altri dettagli, vedere https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing. |
| IMsalMtlsHttpClientFactory |
Factory responsabile della creazione di istanze HttpClient configurate per tls reciproco (mTLS). Questa factory è destinata all'uso per proteggere la comunicazione con Azure AD tramite mTLS. Per altri dettagli sulla creazione di istanze di HttpClient, vedere https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-8.0#instancing. |
| IMsalSFHttpClientFactory |
Factory responsabile della creazione di HttpClient con un callback di convalida del certificato del server personalizzato. Ciò è utile per lo scenario di Fabric del servizio in cui è necessaria la convalida del certificato server usando il certificato del server. Per altri dettagli, vedere https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing . |
| IPublicClientApplication |
Rappresenta le applicazioni client pubbliche: applicazioni desktop e per dispositivi mobili. |
| ITelemetryConfig |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| ITelemetryEventPayload |
Dati che rappresentano un singolo snapshot nella serie di eventi raccolti |
| ITokenCache |
Si tratta dell'interfaccia che implementa l'accesso pubblico alle operazioni della cache. Con CacheV2, questa operazione deve essere necessaria solo se il chiamante rende persistente la cache nel proprio archivio, poiché in questo modo verranno fornite le notifiche di serializzazione/deserializzazione e prima/dopo usate in tale scenario. Fare riferimento a https://aka.ms/aka.ms/msal-net-token-cache-serialization |
| ITokenCacheSerializer |
Questa interfaccia sarà disponibile nel callback TokenCacheNotificationArgs per abilitare la serializzazione/deserializzazione della cache. |
Enumerazioni
| Nome | Descrizione |
|---|---|
| AadAuthorityAudience |
Specifica quali account Microsoft possono essere usati per l'accesso con una determinata applicazione. Fare riferimento a https://aka.ms/msal-net-application-configuration |
| AzureCloudInstance |
InstallazioneUso dell'interfaccia .NET Command-Line:Using the .NET Command-Line Interface (CLI):
Uso dell'interfaccia della riga di comando nuGet:
Uso della console Gestione pacchetti:
Uso di Visual Studio:
DocumentazionePer iniziare, vedere la guida Libreria di Autenticazione Microsoft per .NET. EsempiFare riferimento a Microsoft Identity Platform esempi di codice e a Samples Browser. |
| BrokerOptions.OperatingSystems |
Sistemi operativi supportati |
| CacheRefreshReason |
Specifica il motivo del recupero del token di accesso dal provider di identità quando si usa AcquireTokenSilent, AcquireTokenForClient o AcquireTokenOnBehalfOf. |
| LogLevel |
Rappresenta il livello di log in MSAL. Per informazioni dettagliate, vedere Registrazione MSAL. |
| TelemetryAudienceType |
Descrive i tipi di destinatari per i dati di telemetria. AudienceType |
| TokenSource |
Specifica l'origine dei token di accesso e ID nel risultato dell'autenticazione. |
| UiRequiredExceptionClassification |
Informazioni dettagliate sulla causa di un oggetto MsalUiRequiredException, fornendo un suggerimento su ciò che l'utente può aspettarsi quando passa attraverso l'autenticazione interattiva. Per informazioni dettagliate, vedere Informazioni su MsalUiRequiredException . |
Delegati
| Nome | Descrizione |
|---|---|
| LogCallback |
Delegato di callback che consente agli sviluppatori di applicazioni di utilizzare i log e gestirli in modo personalizzato. Questo callback viene impostato usando WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>).
Se |
| TokenCacheCallback |
Notifica per determinate interazioni della cache dei token durante l'acquisizione del token. Questo delegato viene usato in particolare per fornire una serializzazione della cache dei token personalizzata. Fare riferimento a https://aka.ms/aka.ms/msal-net-token-cache-serialization |
Commenti
Contributi
Apprezziamo il feedback e i contributi per contribuire a rendere Libreria di Autenticazione Microsoft per .NET migliore! Prima di iniziare, leggere i documenti seguenti:
Problemi
Per fornire commenti e suggerimenti sulla raccolta o segnalare un bug, aprire un problema in GitHub.