Microsoft.Identity.Client Espacio de nombres
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Microsoft.Identity.Clientes el espacio de nombres principal del Biblioteca de autenticación de Microsoft (MSAL) para .NET, disponible a través del Microsoft.Identity.Client paquete. Contiene todos los componentes clave que necesita para adquirir un token de los proveedores de autenticación admitidos.
Installation
Uso de la interfaz .NET Command-Line (CLI):
dotnet add package Microsoft.Identity.Client
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
nuget install Microsoft.Identity.Client
Con la consola de Administrador de paquetes:
Install-Package Microsoft.Identity.Client
Uso de Visual Studio:
- Abra el Explorador de soluciones.
- Haga clic con el botón derecho en un proyecto dentro de la solución.
- Haga clic en Administrar paquetes NuGet...
- Haga clic en la pestaña Examinar y busque
Microsoft.Identity.Client. - Haga clic en el
Microsoft.Identity.Clientpaquete y haga clic en Instalar.
Documentation
Para empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET.
Samples
Consulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos.
Clases
| Nombre | Description |
|---|---|
| AbstractAcquireTokenParameterBuilder<T> |
Clase base para generadores de solicitudes de token, que intentan adquirir un token basado en los parámetros proporcionados. |
| AbstractApplicationBuilder<T> |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| AbstractClientAppBaseAcquireTokenParameterBuilder<T> |
Clase base para generadores de parámetros comunes a las operaciones de adquisición de tokens de aplicación cliente confidencial y aplicación cliente pública |
| AbstractConfidentialClientAcquireTokenParameterBuilder<T> |
Clase base para generadores de solicitudes de token de aplicación cliente confidenciales |
| AbstractManagedIdentityAcquireTokenParameterBuilder<T> |
Clase base abstracta para generadores de solicitudes de token de aplicación de identidad administrada. |
| AbstractPublicClientAcquireTokenParameterBuilder<T> |
Clase base para generadores de solicitudes de token de aplicación cliente público |
| AccountExtensions |
Métodos de extensión para IAccount |
| AccountId |
Identificador de una cuenta en un inquilino específico. Devuelto por IAccount.HomeAccountId |
| AcquireTokenByAuthorizationCodeParameterBuilder |
Builder for AcquireTokenByAuthorizationCode |
| AcquireTokenByIntegratedWindowsAuthParameterBuilder |
Generador para AcquireTokenByIntegratedWindowsAuth |
| AcquireTokenByRefreshTokenParameterBuilder |
Generador de parámetros para el AcquireTokenByRefreshToken(IEnumerable<String>, String) método . Vea https://aka.ms/msal-net-migration-adal2-msal2. |
| AcquireTokenByUserFederatedIdentityCredentialParameterBuilder |
Generador de parámetros para la AcquireTokenByUserFederatedIdentityCredential(IEnumerable<String>, String, String) operación. |
| AcquireTokenByUsernameAndPasswordConfidentialParameterBuilder |
Generador de parámetros para la AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) operación. Vea https://aka.ms/msal-net-up. |
| AcquireTokenByUsernamePasswordParameterBuilder |
Generador de parámetros para la AcquireTokenByUsernamePassword(IEnumerable<String>, String, String) operación. Vea https://aka.ms/msal-net-up. |
| AcquireTokenForClientParameterBuilder |
Generador para AcquireTokenForClient (usado en flujos de credenciales de cliente, en aplicaciones de demonio). Vea https://aka.ms/msal-net-client-credentials. |
| AcquireTokenForManagedIdentityParameterBuilder |
Generador de AcquireTokenForManagedIdentity (se usa para obtener el token para identidades administradas). Vea https://aka.ms/msal-net-managed-identity. |
| AcquireTokenInteractiveParameterBuilder |
Generador para una solicitud de token interactiva. Vea https://aka.ms/msal-net-acquire-token-interactively. |
| AcquireTokenOnBehalfOfParameterBuilder |
Generador para AcquireTokenOnBehalfOf (flujo de OBO) Consulte https://aka.ms/msal-net-on-behalf-of |
| AcquireTokenSilentParameterBuilder |
Generador de parámetros para la AcquireTokenSilent(IEnumerable<String>, IAccount) operación. Vea https://aka.ms/msal-net-acquiretokensilent. |
| AcquireTokenWithDeviceCodeParameterBuilder |
Generador de parámetros para la AcquireTokenWithDeviceCode(IEnumerable<String>, Func<DeviceCodeResult,Task>) operación. Vea https://aka.ms/msal-net-device-code-flow. |
| ApplicationBase |
Interfaz que se usa para la creación de aplicaciones cliente. Para obtener más información, consulte https://aka.ms/msal-net-client-applications. |
| ApplicationOptions |
Clase base para objetos de opciones con valores de cadena que se pueden cargar desde un archivo de configuración (por ejemplo, un archivo JSON, como en un escenario de configuración de asp.net) Vea también https://aka.ms/msal-net-application-configuration clases derivadas PublicClientApplicationOptions y ConfidentialClientApplicationOptions |
| AssertionRequestOptions |
Información sobre la aserción de cliente que se debe generar. Consulte https://aka.ms/msal-net-client-assertion |
| AuthenticationHeaderParser |
Encabezados de autenticación analizados para recuperar valores de encabezado de HttpResponseHeaders. |
| AuthenticationInfoParameters |
Parámetros devueltos por el encabezado Authentication-Info. Esto permite escenarios como la prueba de posesión, etc. Consulte https://www.rfc-editor.org/rfc/rfc7615 |
| AuthenticationResult |
Contiene los resultados de una operación de adquisición de tokens en PublicClientApplication o ConfidentialClientApplication. Para obtener más información, consulte https://aka.ms/msal-net-authenticationresult |
| AuthenticationResultMetadata |
Contiene metadatos del resultado de autenticación. Metrics para métricas adicionales de MSAL. |
| BaseAbstractAcquireTokenParameterBuilder<T> |
Clase base para generadores de solicitudes de token, que intentan adquirir un token basado en los parámetros proporcionados. |
| BaseAbstractApplicationBuilder<T> |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| BaseApplicationOptions |
Clase base para objetos de opciones con valores de cadena que se pueden cargar desde un archivo de configuración (por ejemplo, un archivo JSON, como en un escenario de configuración de asp.net) Vea https://aka.ms/msal-net-application-configuration también clases derivadas. ApplicationOptions |
| BrokerOptions |
La clase especifica las opciones de agente en OperatingSystems Las propiedades comunes son propiedades específicas de la plataforma de miembros directos (si existen) forman parte de las opciones correspondientes. |
| CacheOptions |
Opciones para las cachés de tokens de MSAL. |
| ClientApplicationBase |
Clase abstracta que contiene propiedades y métodos de API comunes. ConfidentialClientApplication PublicClientApplication extiende esta clase y confidentialClientApplication. Para obtener más información, consulte https://aka.ms/msal-net-client-applications |
| ClientSignedAssertion |
Contenedor devuelto desde |
| ConfidentialClientApplication |
Clase que se usará para aplicaciones cliente confidenciales (aplicaciones web, API web y aplicaciones de demonio). |
| ConfidentialClientApplicationBuilder |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| ConfidentialClientApplicationOptions |
Opciones de configuración para una aplicación cliente confidencial (aplicación web, API web o aplicación de demonio). Vea https://aka.ms/msal-net/application-configuration. |
| DeviceCodeResult |
Este objeto se devuelve como parte del flujo de código del dispositivo y tiene información destinada a mostrarse al usuario sobre dónde navegar al inicio de sesión y qué código de dispositivo debe escribirse en ese dispositivo. Consulte https://aka.ms/msal-device-code-flow. |
| EmbeddedWebViewOptions |
Opciones para usar la vista web insertada. |
| GetAuthorizationRequestUrlParameterBuilder |
NOTA: Algunos de los métodos de AbstractAcquireTokenParameterBuilder (por ejemplo, cuenta) no tienen sentido aquí. ¿Deseamos crear una base adicional que contenga TODOS los métodos comunes y, a continuación, tener otra cuenta incluida, etc., que solo se usen para AcquireToken? |
| IntuneAppProtectionPolicyRequiredException |
Esta excepción se produce cuando Intune requiere una directiva de protección de aplicaciones. La aplicación puede usar la información de esta excepción para obtener el identificador de inscripción necesario del SDK de Administración de aplicaciones móviles (MAM). Vea https://aka.ms/msal-net-trueMAM. |
| ManagedIdentityApplication |
Clase que se usará para las aplicaciones de identidad administrada (en recursos de Azure como App Services, Virtual Machines, Azure Arc, Service Fabric y Cloud Shell). |
| ManagedIdentityApplicationBuilder |
Generador de aplicaciones de identidad administrada. |
| ManagedIdentityPopExtensions |
Métodos de extensión para habilitar la prueba de posesión de mTLS en flujos de identidad administrada. |
| Metrics |
Métricas de msal. |
| MsalClaimsChallengeException |
Esta excepción indica que las notificaciones se han devuelto desde el punto de conexión que se deben resolver. Esto se puede lograr mediante su uso en la siguiente solicitud de autenticación. Consulte Desafíos de acceso condicional y notificaciones. Consulte Control de la autenticación multifactor (MFA), el acceso condicional y el consentimiento incremental. |
| MsalClientException |
Esta clase de excepción representa errores que son locales para la biblioteca o el dispositivo. Contrario a MsalServiceException lo que representa los errores que se producen desde el servicio de Azure AD o la red. Si desea obtener información más detallada, consulte https://aka.ms/msal-net-exceptions. |
| MsalError |
Código de error devuelto como una propiedad en MsalException |
| MsalException |
Tipo de excepción base que se produce cuando se produce un error durante la adquisición de tokens. Si desea obtener información más detallada, consulte https://aka.ms/msal-net-exceptions. |
| MsalManagedIdentityException |
Esta clase de excepción es para las excepciones generadas a partir de orígenes de identidad administrada. Esta clase está en desuso y se quitará en una versión futura. En su lugar, capture MsalServiceException. Si desea obtener información más detallada, consulte https://aka.ms/msal-net-managed-identity. |
| MsalServiceException |
Tipo de excepción que se produce cuando el servicio devuelve una respuesta de error u otros errores de red. Si desea obtener información más detallada, consulte https://aka.ms/msal-net-exceptions. |
| MsalThrottledServiceException |
Tipo de excepción que se produce cuando MSAL detecta que una aplicación intenta adquirir un token con demasiada frecuencia, como resultado de:
Las propiedades de esta excepción son idénticas a la excepción original. Para obtener más información, consulte https://aka.ms/msal-net-throttling |
| MsalThrottledUiRequiredException |
Tipo de excepción que se produce cuando MSAL detecta que una aplicación intenta adquirir un token aunque se haya producido recientemente.MsalUiRequiredException Para mitigar esto, cuando se encuentra un MsalUiRequiredException , la aplicación debe cambiar a adquirir un token de forma interactiva. Para comprender mejor por qué se produjo, MsalUiRequiredException inspeccione la Classification propiedad . Las propiedades de esta excepción son idénticas a la excepción original. Para obtener más información, consulte https://aka.ms/msal-net-throttling |
| MsalUiRequiredException |
Esta clase de excepción es informar a los desarrolladores de que la interacción de la interfaz de usuario es necesaria para que la autenticación se realice correctamente. Se produce al llamar a AcquireTokenSilent(IEnumerable<String>, IAccount) o a una de sus invalidaciones, y cuando el token no existe en la memoria caché, o el usuario necesita proporcionar más contenido o realizar la autenticación multifactor basada en directivas de AD de Azure, etc.. Si desea obtener información más detallada, consulte https://aka.ms/msal-net-exceptions. |
| OsCapabilitiesExtensions |
Métodos de extensión |
| PublicClientApplication |
Clase abstracta que contiene propiedades y métodos de API comunes. Para obtener más información, consulte https://aka.ms/msal-net-client-applications |
| PublicClientApplicationBuilder |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| PublicClientApplicationExtensions |
Métodos de extensibilidad para IPublicClientApplication |
| PublicClientApplicationOptions |
Opciones de configuración para una aplicación cliente pública (aplicación de escritorio o móvil). Vea https://aka.ms/msal-net/application-configuration. |
| RegionDetails |
Contiene el resultado de la región cuando se usa la detección de regiones msal, publicada como parte de AuthenticationResultMetadata. AuthenticationResultMetadata para obtener información adicional de metadatos del resultado de autenticación. |
| SystemWebViewOptions |
Opciones para usar el explorador del sistema operativo predeterminado como un proceso independiente para controlar la autenticación interactiva. MSAL escuchará al explorador del sistema operativo para finalizar la autenticación, pero no puede cerrar el explorador. Sin embargo, puede responder con un mensaje 200 OK o una redirección 302, que se puede configurar aquí. Para obtener más información, consulte https://aka.ms/msal-net-os-browser |
| TenantProfile |
Representa una cuenta en un inquilino específico. La misma cuenta puede existir en su inquilino principal y también como invitado en varios otros inquilinos. Los tokens de acceso y los tokens de identificador son específicos del inquilino y este objeto proporciona información de alto nivel sobre todos los tokens de identificador asociados a la cuenta. |
| TokenCache |
Caché de tokens que almacena tokens de acceso y actualización para cuentas Esta clase se usa en los constructores de PublicClientApplication y ConfidentialClientApplication. En el caso de ConfidentialClientApplication, se usan dos instancias, una para la caché de tokens de usuario y otra para la caché de tokens de aplicación (en el caso de las aplicaciones que usan los flujos de credenciales de cliente). |
| TokenCacheExtensions |
Métodos de extensión para ITokenCache |
| TokenCacheNotificationArgs |
Contiene parámetros usados por la llamada MSAL que accede a la memoria caché. Consulte también ITokenCacheSerializer qué contiene métodos para personalizar la serialización de caché. Para más información sobre la caché de tokens, consulte https://aka.ms/msal-net-web-token-cache |
| TraceTelemetryConfig |
Implementación sencilla ITelemetryConfig que escribe datos mediante System.Diagnostics.Trace. |
| UserAssertion |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| WindowsBrokerOptions |
Opciones avanzadas para usar el agente de Windows 10. Para obtener más información, consulte https://aka.ms/msal-net-wam |
| WwwAuthenticateParameters |
Parámetros devueltos por el encabezado WWW-Authenticate. Esto permite escenarios dinámicos, como desafío de notificaciones, evaluación continua de acceso (CAE) y acceso condicional (CA). Consulte https://aka.ms/msal-net/wwwAuthenticate. |
Estructuras
| Nombre | Description |
|---|---|
| Prompt |
Estructura que contiene miembros estáticos que puede usar para especificar cómo las invalidaciones interactivas de AcquireTokenAsync en IPublicClientApplication deben preguntar al usuario. |
Interfaces
| Nombre | Description |
|---|---|
| IAccount |
La interfaz IAccount representa información sobre una sola cuenta.
El mismo usuario puede estar presente en distintos inquilinos, es decir, un usuario puede tener varias cuentas.
|
| IAppConfig |
Propiedades de configuración usadas para compilar una aplicación cliente pública o confidencial. |
| IApplicationBase |
Interfaz que se usa para la creación de aplicaciones cliente. Para obtener más información, consulte https://aka.ms/msal-net-client-applications. |
| IByRefreshToken |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| IByUserFederatedIdentityCredential |
Proporciona una interfaz para adquirir tokens mediante el flujo de credenciales de identidad federada de usuario (UserFIC). |
| IByUsernameAndPassword |
Proporciona una interfaz explícita para usar la concesión de contraseña del propietario del recurso en el cliente confidencial. |
| IClientApplicationBase |
Interfaz que define propiedades y métodos de API comunes. Tanto como PublicClientApplicationConfidentialClientApplication extiendan esta clase. Para obtener más información, consulte https://aka.ms/msal-net-client-applications |
| IConfidentialClientApplication |
Representa aplicaciones cliente confidenciales: aplicaciones web, API web, aplicaciones de demonio. |
| ILongRunningWebApi |
Métodos para procesos de ejecución prolongada o en segundo plano en las API web. |
| IManagedIdentityApplication |
Componente que se va a usar con aplicaciones de identidad administrada para Azure recursos. |
| IMsalHttpClientFactory |
Factoría responsable de crear HttpClient. Consulte https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing para obtener más detalles. |
| IMsalMtlsHttpClientFactory |
Generador responsable de crear instancias httpClient configuradas para TLS mutua (mTLS). Esta fábrica está diseñada para usarse para proteger la comunicación con Azure AD mediante mTLS. Para obtener más información sobre la creación de instancias de HttpClient, consulte https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=net-8.0#instancing. |
| IMsalSFHttpClientFactory |
Factoría responsable de crear HttpClient con una devolución de llamada de validación de certificados de servidor personalizada. Esto es útil para el escenario de Service Fabric en el que se requiere la validación del certificado de servidor mediante el certificado de servidor. Consulte https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing para obtener más información. |
| IPublicClientApplication |
Representa aplicaciones cliente públicas: aplicaciones móviles y de escritorio. |
| ITelemetryConfig |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| ITelemetryEventPayload |
Datos que representan una sola instantánea en la serie de eventos que se recopilan |
| ITokenCache |
Esta es la interfaz que implementa el acceso público a las operaciones de caché. Con CacheV2, esto solo debe ser necesario si el autor de la llamada conserva la memoria caché en su propio almacén, ya que esto proporcionará la serialización o deserialización y antes y después de las notificaciones usadas en ese escenario. Vea https://aka.ms/aka.ms/msal-net-token-cache-serialization. |
| ITokenCacheSerializer |
Esta interfaz estará disponible en la devolución de llamada de TokenCacheNotificationArgs para habilitar la serialización o deserialización de la memoria caché. |
Enumeraciones
| Nombre | Description |
|---|---|
| AadAuthorityAudience |
Especifica qué cuentas de Microsoft se pueden usar para el inicio de sesión con una aplicación determinada. Vea https://aka.ms/msal-net-application-configuration. |
| AzureCloudInstance |
InstallationUso de la interfaz .NET Command-Line (CLI):
Uso de la interfaz de la línea de comandos (CLI) de NuGet:
Con la consola de Administrador de paquetes:
Uso de Visual Studio:
DocumentationPara empezar, consulte la guía de Biblioteca de autenticación de Microsoft de .NET. SamplesConsulte Plataforma de identidad de Microsoft ejemplos de código y el Explorador de ejemplos. |
| BrokerOptions.OperatingSystems |
Sistemas operativos compatibles |
| CacheRefreshReason |
Especifica el motivo para capturar el token de acceso del proveedor de identidades al usar AcquireTokenSilent, AcquireTokenForClient o AcquireTokenOnBehalfOf. |
| LogLevel |
Representa el nivel de registro en MSAL. Para obtener más información, consulte Registro de MSAL. |
| TelemetryAudienceType |
Describe los tipos de audiencias para la telemetría. AudienceType |
| TokenSource |
Especifica el origen de los tokens de acceso e identificador en el resultado de la autenticación. |
| UiRequiredExceptionClassification |
Detalles sobre la causa de un MsalUiRequiredException, dando una sugerencia sobre lo que el usuario puede esperar cuando pasan por la autenticación interactiva. Consulte Understanding MsalUiRequiredException (Descripción de MsalUiRequiredException ) para obtener más información. |
Delegados
| Nombre | Description |
|---|---|
| LogCallback |
Delegado de devolución de llamada que permite a los desarrolladores de aplicaciones consumir registros y controlarlos de forma personalizada. Esta devolución de llamada se establece mediante WithLogging(LogCallback, Nullable<LogLevel>, Nullable<Boolean>, Nullable<Boolean>).
Si |
| TokenCacheCallback |
Notificación de determinadas interacciones de caché de tokens durante la adquisición de tokens. Este delegado se usa en particular para proporcionar una serialización de caché de tokens personalizada. Vea https://aka.ms/aka.ms/msal-net-token-cache-serialization. |
Comentarios
Contribuciones
Agradecemos comentarios y contribuciones para ayudar a mejorar la Biblioteca de autenticación de Microsoft para .NET mejor! Antes de empezar, lea los siguientes documentos:
Problemas
Para proporcionar comentarios de biblioteca o notificar un error, abra un problema en GitHub.