Microsoft.Identity.Client Namnområde
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Microsoft.Identity.Clientär kärnnamnområdet för Microsofts autentiseringsbibliotek (MSAL) för .NET, som är tillgängligt via Microsoft.Identity.Client paketet. Den innehåller alla viktiga komponenter som du behöver för att hämta en token från autentiseringsprovidrar som stöds.
Installation
Med hjälp av .NET Command-Line Interface (CLI):
dotnet add package Microsoft.Identity.Client
Använda NuGet-kommandoradsgränssnittet (CLI):
nuget install Microsoft.Identity.Client
Använda Správca balíkov-konsolen:
Install-Package Microsoft.Identity.Client
Använda Visual Studio:
- Öppna Prieskumník riešení.
- Högerklicka på ett projekt i lösningen.
- Klicka på Hantera NuGet-paket...
- Klicka på fliken Bläddra och sök
Microsoft.Identity.Clientefter . - Klicka på paketet
Microsoft.Identity.Clientoch klicka på Installera.
Documentation
Kom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET.
Samples
Se Microsofts identitetsplattform kodexempel och exempelwebbläsaren.
Klasser
| Name | Description |
|---|---|
| AbstractAcquireTokenParameterBuilder<T> |
Basklass för byggare av tokenbegäranden, som försöker hämta en token baserat på de angivna parametrarna. |
| AbstractApplicationBuilder<T> |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| AbstractClientAppBaseAcquireTokenParameterBuilder<T> |
Basklass för parameterbyggare som är gemensamma för offentliga klientprogram och konfidentiella anskaffningsåtgärder för klientprogramtoken |
| AbstractConfidentialClientAcquireTokenParameterBuilder<T> |
Basklass för byggare av konfidentiella klientprogramtokenbegäranden |
| AbstractManagedIdentityAcquireTokenParameterBuilder<T> |
Abstrakt basklass för byggare av tokenbegäran för hanterade identitetsprogram. |
| AbstractPublicClientAcquireTokenParameterBuilder<T> |
Basklass för byggare av tokenbegäran för offentliga klientprogram |
| AccountExtensions |
Tilläggsmetoder för IAccount |
| AccountId |
En identifierare för ett konto i en specifik klientorganisation. Returneras av IAccount.HomeAccountId |
| AcquireTokenByAuthorizationCodeParameterBuilder |
Builder för AcquireTokenByAuthorizationCode |
| AcquireTokenByIntegratedWindowsAuthParameterBuilder |
Builder för AcquireTokenByIntegratedWindowsAuth |
| AcquireTokenByRefreshTokenParameterBuilder |
Parameter builder för AcquireTokenByRefreshToken(IEnumerable<String>, String) metoden. Se https://aka.ms/msal-net-migration-adal2-msal2 |
| AcquireTokenByUserFederatedIdentityCredentialParameterBuilder |
Parameterverktyget för åtgärden AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String) . |
| AcquireTokenByUsernameAndPasswordConfidentialParameterBuilder |
Parameterverktyget för åtgärden AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) . Se https://aka.ms/msal-net-up |
| AcquireTokenByUsernamePasswordParameterBuilder |
Parameterverktyget för åtgärden AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) . Se https://aka.ms/msal-net-up |
| AcquireTokenForClientParameterBuilder |
Builder för AcquireTokenForClient (används i klientautentiseringsflöden i daemonprogram). Se https://aka.ms/msal-net-client-credentials |
| AcquireTokenForManagedIdentityParameterBuilder |
Builder för AcquireTokenForManagedIdentity (används för att hämta token för hanterade identiteter). Se https://aka.ms/msal-net-managed-identity |
| AcquireTokenInteractiveParameterBuilder |
Byggare för en interaktiv tokenbegäran. Se https://aka.ms/msal-net-acquire-token-interactively |
| AcquireTokenOnBehalfOfParameterBuilder |
Builder för AcquireTokenOnBehalfOf (OBO-flöde) Se https://aka.ms/msal-net-on-behalf-of |
| AcquireTokenSilentParameterBuilder |
Parameterverktyget för åtgärden AcquireTokenSilent(IEnumerable<String>, IAccount) . Se https://aka.ms/msal-net-acquiretokensilent |
| AcquireTokenWithDeviceCodeParameterBuilder |
Parameterverktyget för åtgärden AcquireTokenWithDeviceCode(IEnumerable<String>, Func<DeviceCodeResult,Task>) . Se https://aka.ms/msal-net-device-code-flow |
| ApplicationBase |
Gränssnitt som används för att skapa klientprogram. Mer information finns i https://aka.ms/msal-net-client-applications. |
| ApplicationOptions |
Basklass för alternativobjekt med strängvärden som kan läsas in från en konfigurationsfil (till exempel en JSON-fil, som i ett asp.net konfigurationsscenario) Se https://aka.ms/msal-net-application-configuration Även härledda klasser PublicClientApplicationOptions och ConfidentialClientApplicationOptions |
| AssertionRequestOptions |
Information om klientkontroll som måste genereras Se https://aka.ms/msal-net-client-assertion |
| AuthenticationHeaderParser |
Parsade autentiseringshuvuden för att hämta rubrikvärden från HttpResponseHeaders. |
| AuthenticationInfoParameters |
Parametrar som returneras av Authentication-Info-huvudet. Detta möjliggör scenarier som innehavsbevis osv. Se https://www.rfc-editor.org/rfc/rfc7615 |
| AuthenticationResult |
Innehåller resultatet av en tokenförvärvsåtgärd i PublicClientApplication eller ConfidentialClientApplication. Mer information finns i https://aka.ms/msal-net-authenticationresult |
| AuthenticationResultMetadata |
Innehåller metadata för autentiseringsresultatet. Metrics för ytterligare MSAL-omfattande mått. |
| BaseAbstractAcquireTokenParameterBuilder<T> |
Basklass för byggare av tokenbegäranden, som försöker hämta en token baserat på de angivna parametrarna. |
| BaseAbstractApplicationBuilder<T> |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| BaseApplicationOptions |
Basklass för alternativobjekt med strängvärden som kan läsas in från en konfigurationsfil (till exempel en JSON-fil, som i ett asp.net konfigurationsscenario) Se https://aka.ms/msal-net-application-configuration även härledda klasser ApplicationOptions |
| BrokerOptions |
Klassen anger alternativen för broker över OperatingSystems De vanliga egenskaperna är direkta medlemmar Plattformsspecifika egenskaper (om de finns) är en del av motsvarande alternativ |
| CacheOptions |
Alternativ för MSAL-tokencacheminnen. |
| ClientApplicationBase |
Abstrakt klass som innehåller vanliga API-metoder och egenskaper. Både PublicClientApplication och ConfidentialClientApplication utökar den här klassen. Mer information finns i https://aka.ms/msal-net-client-applications |
| ClientSignedAssertion |
Containern som returnerades från |
| ConfidentialClientApplication |
Klass som ska användas för konfidentiella klientprogram (webbappar, webb-API:er och daemonprogram). |
| ConfidentialClientApplicationBuilder |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| ConfidentialClientApplicationOptions |
Konfigurationsalternativ för ett konfidentiellt klientprogram (webbapp/webb-API/daemonapp). Se https://aka.ms/msal-net/application-configuration |
| DeviceCodeResult |
Det här objektet returneras som en del av enhetskodflödet och har information som ska visas för användaren om var du ska navigera till inloggningen och vad enhetskoden måste anges på enheten. Se även https://aka.ms/msal-device-code-flow. |
| EmbeddedWebViewOptions |
Alternativ för att använda den inbäddade webbvyn. |
| GetAuthorizationRequestUrlParameterBuilder |
Obs! Några av metoderna i AbstractAcquireTokenParameterBuilder (t.ex. konto) är inte meningsfulla här. Vill vi skapa en ytterligare bas som innehåller alla vanliga metoder och sedan ha ett annat inklusive konto osv som endast används för AcquireToken? |
| IntuneAppProtectionPolicyRequiredException |
Det här undantaget utlöses när Intune kräver en appskyddsprincip. Informationen i det här undantaget kan användas av appen för att hämta det registrerings-ID som krävs från MAM-SDK (Mobile App Management). Se https://aka.ms/msal-net-trueMAM |
| ManagedIdentityApplication |
Klass som ska användas för hanterade identitetsprogram (på Azure resurser som App Services, Virtual Machines, Azure Arc, Service Fabric och Cloud Shell). |
| ManagedIdentityApplicationBuilder |
Builder för hanterade identitetsprogram. |
| ManagedIdentityPopExtensions |
Tilläggsmetoder för att aktivera mTLS Proof-of-Possession i hanterade identitetsflöden. |
| Metrics |
MSAL-omfattande mått. |
| MsalClaimsChallengeException |
Det här undantaget anger att anspråk har returnerats från slutpunkten som måste lösas. Detta kan uppnås genom att använda dem i nästa autentiseringsbegäran. Se Utmaningar med villkorsstyrd åtkomst och anspråk. Se Hantera multifaktorautentisering (MFA), villkorlig åtkomst och inkrementellt medgivande. |
| MsalClientException |
Den här undantagsklassen representerar fel som är lokala för biblioteket eller enheten. I motsats till MsalServiceException vilka representerar fel som inträffar från Azure AD-tjänsten eller nätverket. Mer information finns i https://aka.ms/msal-net-exceptions |
| MsalError |
Felkod som returneras som en egenskap i MsalException |
| MsalException |
Grundläggande undantagstyp utlöses när ett fel inträffar under tokenförvärvet. Mer information finns i https://aka.ms/msal-net-exceptions |
| MsalManagedIdentityException |
Den här undantagsklassen gäller undantag som genereras från hanterade identitetskällor. Den här klassen är inaktuell och tas bort i en framtida version. Fånga MsalServiceException i stället. Mer information finns i https://aka.ms/msal-net-managed-identity |
| MsalServiceException |
Undantagstyp som utlöses när tjänsten returnerar ett felsvar eller andra nätverksfel inträffar. Mer information finns i https://aka.ms/msal-net-exceptions |
| MsalThrottledServiceException |
Undantagstyp som genereras när MSAL identifierar att ett program försöker hämta en token för ofta, till följd av:
Egenskaperna för det här undantaget är identiska med det ursprungliga undantaget Mer information finns i https://aka.ms/msal-net-throttling |
| MsalThrottledUiRequiredException |
Undantagstyp som genereras när MSAL identifierar att ett program försöker hämta en token trots att en MsalUiRequiredException nyligen har genererats. För att minimera detta, när ett MsalUiRequiredException påträffas, bör programmet växla till att hämta en token interaktivt. För att bättre förstå varför kastades MsalUiRequiredException , inspektera fastigheten Classification . Egenskaperna för det här undantaget är identiska med det ursprungliga undantaget Mer information finns i https://aka.ms/msal-net-throttling |
| MsalUiRequiredException |
Den här undantagsklassen är till för att informera utvecklare om att interaktion med användargränssnittet krävs för att autentiseringen ska lyckas. Den utlöses vid anrop AcquireTokenSilent(IEnumerable<String>, IAccount) eller någon av dess åsidosättningar, och när token inte finns i cacheminnet, eller om användaren behöver ange mer innehåll eller utföra multifaktorautentisering baserat på Azure AD-principer osv.. Mer information finns i https://aka.ms/msal-net-exceptions |
| OsCapabilitiesExtensions |
Tilläggsmetoder |
| PublicClientApplication |
Abstrakt klass som innehåller vanliga API-metoder och egenskaper. Mer information finns i https://aka.ms/msal-net-client-applications |
| PublicClientApplicationBuilder |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| PublicClientApplicationExtensions |
Utökningsmetoder för IPublicClientApplication |
| PublicClientApplicationOptions |
Konfigurationsalternativ för ett offentligt klientprogram (skrivbord/mobilapp). Se https://aka.ms/msal-net/application-configuration |
| RegionDetails |
Innehåller resultatet av regionen när MSAL-regionidentifiering används, publicerad som en del av AuthenticationResultMetadata. AuthenticationResultMetadata för ytterligare metadatainformation om autentiseringsresultatet. |
| SystemWebViewOptions |
Alternativ för att använda standardwebbläsaren som en separat process för att hantera interaktiv autentisering. MSAL lyssnar efter att OS-webbläsaren har slutfört autentiseringen, men den kan inte stänga webbläsaren. Det kan dock svara med ett 200 OK-meddelande eller en 302-omdirigering, som kan konfigureras här. Mer information finns i https://aka.ms/msal-net-os-browser |
| TenantProfile |
Representerar ett konto i en specifik klientorganisation. Samma konto kan finnas i hemklientorganisationen och även som gäst i flera andra klienter. Åtkomsttoken och ID-token är klientspecifika och det här objektet innehåller information på hög nivå om alla ID-token som är associerade med kontot. |
| TokenCache |
Tokencachelagring av åtkomst- och uppdateringstoken för konton Den här klassen används i konstruktorerna PublicClientApplication för och ConfidentialClientApplication. När det gäller ConfidentialClientApplication används två instanser, en för cacheminnet för användartoken och en för cacheminnet för programtoken (om program använder autentiseringsflödena för klienten). |
| TokenCacheExtensions |
Tilläggsmetoder för ITokenCache |
| TokenCacheNotificationArgs |
Innehåller parametrar som används av MSAL-anropet som kommer åt cachen. Se även ITokenCacheSerializer vilka som innehåller metoder för att anpassa cache-serialiseringen. Mer information om tokencachen finns i https://aka.ms/msal-net-web-token-cache |
| TraceTelemetryConfig |
En enkel ITelemetryConfig implementering som skriver data med System.Diagnostics.Trace. |
| UserAssertion |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| WindowsBrokerOptions |
Avancerade alternativ för att använda Windows 10 broker. Mer information finns i https://aka.ms/msal-net-wam |
| WwwAuthenticateParameters |
Parametrar som returneras av WWW-Authenticate-huvudet. Detta möjliggör dynamiska scenarier som anspråksutmaning, utvärdering av kontinuerlig åtkomst (CAE) och villkorlig åtkomst (CA). Se även https://aka.ms/msal-net/wwwAuthenticate. |
Strukturer
| Name | Description |
|---|---|
| Prompt |
Struktur som innehåller statiska medlemmar som du kan använda för att ange hur interaktiva åsidosättningar av AcquireTokenAsync i IPublicClientApplication ska fråga användaren. |
Gränssnitt
| Name | Description |
|---|---|
| IAccount |
IAccount-gränssnittet representerar information om ett enda konto.
Samma användare kan finnas i olika klientorganisationer, dvs. en användare kan ha flera konton.
En |
| IAppConfig |
Konfigurationsegenskaper som används för att skapa ett offentligt eller konfidentiellt klientprogram. |
| IApplicationBase |
Gränssnitt som används för att skapa klientprogram. Mer information finns i https://aka.ms/msal-net-client-applications. |
| IByRefreshToken |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| IByUserFederatedIdentityCredential |
Tillhandahåller ett gränssnitt för att hämta token med hjälp av user federated Identity Credential -flödet (UserFIC). |
| IByUsernameAndPassword |
Tillhandahåller ett explicit gränssnitt för användning av resursägares lösenordsbeviljande på konfidentiell klient. |
| IClientApplicationBase |
Gränssnitt som definierar vanliga API-metoder och egenskaper. Både PublicClientApplication och ConfidentialClientApplication utöka den här klassen. Mer information finns i https://aka.ms/msal-net-client-applications |
| IConfidentialClientApplication |
Representerar konfidentiella klientprogram – webbappar, webb-API:er, daemonprogram. |
| ILongRunningWebApi |
Metoder för långvariga processer eller bakgrundsprocesser i webb-API:er. |
| IManagedIdentityApplication |
Komponent som ska användas med hanterade identitetsprogram för Azure resurser. |
| IMsalHttpClientFactory |
Fabriksansvarig för att skapa HttpClient. Mer information finns i https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing. |
| IMsalMtlsHttpClientFactory |
En fabrik som ansvarar för att skapa HttpClient-instanser som konfigurerats för ömsesidig TLS (mTLS). Den här fabriken är avsedd för säker kommunikation med Azure AD med hjälp av mTLS. Mer information om HttpClient-instancing finns https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-8.0#instancingi . |
| IMsalSFHttpClientFactory |
Fabriksansvarig för att skapa HttpClient med ett återanrop för validering av anpassat servercertifikat. Detta är användbart för Fabric scenario där verifiering av servercertifikat krävs med hjälp av servercertifikatet. Mer https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing information finns i. |
| IPublicClientApplication |
Representerar offentliga klientprogram – skrivbordsprogram och mobila program. |
| ITelemetryConfig |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| ITelemetryEventPayload |
Data som representerar en enskild ögonblicksbild i serien med händelser som samlas in |
| ITokenCache |
Det här är gränssnittet som implementerar offentlig åtkomst till cacheåtgärder. Med CacheV2 bör detta endast vara nödvändigt om anroparen bevarar cachen i sitt eget arkiv, eftersom detta ger serialisera/deserialisera och före/efter-meddelanden som används i det scenariot. Se https://aka.ms/aka.ms/msal-net-token-cache-serialization |
| ITokenCacheSerializer |
Det här gränssnittet kommer att vara tillgängligt i TokenCacheNotificationArgs återanrop för att aktivera serialisering/deserialisering av cacheminnet. |
Uppräkningar
| Name | Description |
|---|---|
| AadAuthorityAudience |
Anger vilka Microsoft konton som kan användas för inloggning med ett visst program. Se https://aka.ms/msal-net-application-configuration |
| AzureCloudInstance |
InstallationMed hjälp av .NET Command-Line Interface (CLI):
Använda NuGet-kommandoradsgränssnittet (CLI):
Använda Správca balíkov-konsolen:
Använda Visual Studio:
DocumentationKom igång genom att läsa guiden Microsofts autentiseringsbibliotek för .NET. SamplesSe Microsofts identitetsplattform kodexempel och exempelwebbläsaren. |
| BrokerOptions.OperatingSystems |
Operativsystem som stöds |
| CacheRefreshReason |
Anger orsaken till att hämta åtkomsttoken från identitetsprovidern när du använder AcquireTokenSilent, AcquireTokenForClient eller AcquireTokenOnBehalfOf. |
| LogLevel |
Representerar loggnivå i MSAL. Mer information finns i MSAL-loggning. |
| TelemetryAudienceType |
Beskriver typerna av målgrupper för telemetri. AudienceType |
| TokenSource |
Anger källan för åtkomst- och ID-token i autentiseringsresultatet. |
| UiRequiredExceptionClassification |
Information om orsaken till en MsalUiRequiredException, som ger en ledtråd om vad användaren kan förvänta sig när de går igenom interaktiv autentisering. Mer information finns i Förstå MsalUiRequiredException . |
Delegeringar
| Name | Description |
|---|---|
| LogCallback |
Återanropsdelegat som gör att programutvecklare kan använda loggar och hantera dem på ett anpassat sätt. Det här återanropet anges med .WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>)
Om |
| TokenCacheCallback |
Meddelande för vissa tokencacheinteraktioner under tokenförvärv. Det här ombudet används särskilt för att tillhandahålla en anpassad tokencache-serialisering. Se https://aka.ms/aka.ms/msal-net-token-cache-serialization |
Kommentarer
Bidrag
Vi uppskattar feedback och bidrag för att göra Microsofts autentiseringsbibliotek för .NET bättre! Läs följande dokument innan du kommer igång:
Issues
Om du vill ge biblioteksfeedback eller rapportera en bugg öppnar du ett problem på GitHub.