@azure/msal-node package

Clase de error general producida por la biblioteca MSAL.js.

Clase abstracta base para todas las clientApplications: pública y confidencial

Aserción de cliente de tipo jwt-bearer usada en flujos de cliente confidenciales

Error que se produce cuando se produce un error en el código de cliente que se ejecuta en el explorador.

Error producido cuando se produce un error en la configuración de la biblioteca de MSAL.js.

Concesión de credenciales de cliente de OAuth2.0

Esta clase se usará para adquirir tokens para aplicaciones cliente confidenciales (webApp, webAPI). Las aplicaciones cliente confidenciales configurarán secretos de aplicación, certificados de cliente o aserciones según corresponda.

Esta clase implementa la interfaz criptográfica del nodo MSAL, que permite realizar la codificación y descodificación de base64, generar GUID criptográficos aleatorios e implementar claves de prueba para código Exchange especificaciones para el flujo de código de autorización de OAuth mediante PKCE (rfc aquí: https://tools.ietf.org/html/rfc7636).

Cliente de código de dispositivo OAuth2.0

Complemento de caché que serializa los datos en la memoria caché y deserializa los datos de la caché.

Error que se produce cuando se requiere interacción del usuario.

Clase que facilita el registro de mensajes en un lugar específico.

Clase para inicializar una identidad administrada e identificar el servicio

Cliente deBehalf-Of

Esta clase se usará para adquirir tokens para aplicaciones cliente públicas (escritorio, móvil). Las aplicaciones cliente públicas no son de confianza para almacenar de forma segura secretos de aplicación y, por lo tanto, solo pueden solicitar tokens en el nombre de un usuario.

Error producido cuando se produce un error con el código del servidor, por ejemplo, no disponibilidad.

Administrador de caché de tokens en memoria

Esta instancia de clase ayuda a realizar un seguimiento de los cambios de memoria que facilitan las decisiones de lectura y escritura en la caché persistente.

Cliente de concesión de contraseña de Oauth2.0 Nota: Solo se admiten clientes públicos para la concesión de contraseñas y con fines puramente de prueba

Interfaz para la memoria caché que define un captador y establecedor

Interfaz para la clase ConfidentialClientApplication que define las firmas de API públicas

Interfaz para LoopbackClient que permite reemplazar el servidor de bucle invertido predeterminado por una implementación personalizada.

Interfaz de red de cliente para enviar solicitudes de back-end.

Interfaz que define métodos de captador para obtener claves usadas para identificar datos en la memoria caché

Interfaz para la clase PublicClientApplication que define las firmas de API públicas

Interfaz de caché de tokens para el cliente, lo que proporciona acceso a las API de caché

Objeto account con la firma siguiente:

• homeAccountId: identificador de cuenta principal para este objeto de cuenta
• environment: entidad que emitió el token representado por el dominio del emisor (por ejemplo, login.microsoftonline.com)
• tenantId: inquilino completo o identificador organizativo al que pertenece esta cuenta
• username: preferred_username notificación del id_token que representa esta cuenta
• localAccountId: identificador de cuenta específico del inquilino local para este objeto de cuenta, que se suele usar en casos heredados.
• name: nombre completo de la cuenta, incluido el nombre especificado y el nombre de familia.
• idToken: token de identificador sin formato
• idTokenClaims: el objeto contiene notificaciones del token de identificador
• nativeAccountId: identificador de cuenta nativa del usuario
• tenantProfiles: asignación de objetos de perfil de inquilino para cada inquilino con el que se ha autenticado la cuenta en el explorador
• dataBoundary: límite de datos extraído de clientInfo

Objeto de entrada para la extensiblidad de IAppTokenProvider. MSAL creará este objeto, que se puede usar para ayudar a crear una instancia de AppTokenProviderResult.

• correlationId: el identificador de correlación asociado a la solicitud.
• tenantId: el identificador de inquilino para el que se debe proporcionar el token.
• ámbitos: los ámbitos para los que se debe proporcionar el token
• claims: todas las notificaciones adicionales que el token debe satisfacer

Objeto de salida para la extensiblidad de IAppTokenProvider.

• accessToken: el token de acceso real, normalmente en formato JWT, que satisface los datos de solicitud AppTokenProviderParameters.
• expiresInSeconds: cuánto tiempo tienen los tokens antes de la expiración, en segundos. Similar al campo "expires_in" en una respuesta de token de AAD.
• refreshInSeconds: cuánto tiempo tiene el token antes de actualizarlo de forma proactiva. Similar al campo "refresh_in" en una respuesta de token de AAD.

Resultado devuelto desde el punto de conexión del token de la entidad.

• uniqueId: oid o sub notificación del token de identificador
• tenantId: tid notificación del token de identificador
• ámbitos: ámbitos que se validan para el token correspondiente
• account: una representación de objeto de cuenta del usuario que ha iniciado sesión actualmente
• idToken: token de identificador recibido como parte de la respuesta
• idTokenClaims: notificaciones de token de identificador relevantes de MSAL
• accessToken: token de acceso o certificado SSH recibido como parte de la respuesta
• fromCache: booleano que indica si el token procede de la memoria caché
• expiresOn: objeto Date de Javascript que representa la expiración relativa del token de acceso
• extExpiresOn: objeto Date de Javascript que representa la expiración relativa extendida del token de acceso en caso de interrupción del servidor
• refreshOn: objeto Date de Javascript que representa el tiempo relativo hasta que se debe actualizar un token de acceso.
• state: valor pasado por el usuario en la solicitud
• familyId: identificador de identificador de familia, normalmente solo se usa para tokens de actualización.
• requestId: identificador de solicitud devuelto como parte de la respuesta

Respuesta devuelta después de procesar la cadena o el fragmento de la consulta de respuesta de código.

Solicitar objeto pasado por el usuario para adquirir un token del servidor que intercambia un código de autorización válido (segunda parte del flujo de código de autorización de OAuth2.0)

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• claims: una solicitud de notificaciones con cadena que se agregará a todas las llamadas /authorize y /token.
• authority: : dirección URL de la autoridad, el servicio de token de seguridad (STS) desde el que MSAL adquirirá tokens. Si la autoridad se establece en el objeto de aplicación cliente, esto invalidará ese valor. La invalidación del valor hará que la validación de la autoridad se produzca cada vez. Si se usará la misma autoridad para todas las solicitudes, establezca en el objeto de aplicación en lugar de las solicitudes.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• redirectUri: el URI de redireccionamiento de la aplicación, donde la autoridad le redirigirá después de que el usuario escriba las credenciales y los consentimientos. Debe coincidir exactamente con uno de los URI de redireccionamiento que registró en el portal.
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
• code: el authorization_code que el usuario adquirió en la primera etapa del flujo.
• codeVerifier: el mismo code_verifier que se usó para obtener el authorization_code. Obligatorio si PKCE se usó en la solicitud de concesión de código de autorización. Para obtener más información, consulte PKCE RFC: https://tools.ietf.org/html/rfc7636
• state: GUID único generado por el usuario almacenado en caché por el usuario y enviado al servidor durante la primera etapa del flujo. El servidor envía esta cadena con el código de autorización. A continuación, el estado almacenado en caché del usuario se compara con el estado recibido del servidor para mitigar el riesgo de ataques CSRF. Consulte https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.

Solicitar objeto pasado por el usuario para recuperar un código del servidor (primer paso del flujo de concesión de código de autorización)

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• claims: una solicitud de notificaciones con cadena que se agregará a todas las llamadas /authorize y /token.
• authority: dirección URL de la autoridad a la que la aplicación adquiere tokens.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• redirectUri: el URI de redirección donde la aplicación puede recibir las respuestas de autenticación. Debe coincidir exactamente con uno de los URI de redirección registrados en el portal de Azure.
• extraScopesToConsent: ámbitos para un recurso diferente cuando el usuario necesita consentimiento por adelantado.
• responseMode: especifica el método que se debe usar para enviar el resultado de autenticación a la aplicación. Puede ser consulta, form_post o fragmento. Si no se pasa ningún valor, el valor predeterminado es consultar.
• codeChallenge: se usa para proteger la concesión de código de autorización mediante prueba de clave para código Exchange (PKCE). Para obtener más información, consulte PKCE RCF:https://tools.ietf.org/html/rfc7636
• codeChallengeMethod: método usado para codificar el comprobador de código para el parámetro de desafío de código. Puede ser "sin formato" o "S256". Si se excluye, se supone que el desafío de código es texto no cifrado. Para obtener más información, consulte PKCE RCF: https://tools.ietf.org/html/rfc7636
• state: valor incluido en la solicitud que también se devuelve en la respuesta del token. Normalmente se usa un valor único generado aleatoriamente para evitar ataques de falsificación de solicitudes entre sitios. El estado también se usa para codificar información sobre el estado del usuario en la aplicación antes de que se produjera la solicitud de autenticación.
• prompt: indica el tipo de interacción del usuario necesaria. login: forzará al usuario a escribir sus credenciales en esa solicitud, negando el inicio de sesión único ninguno: garantizará que el usuario no se presente con ningún mensaje interactivo. Si la solicitud no se puede completar a través del inicio de sesión único, el punto de conexión devolverá un consentimiento de error de interaction_required: desencadenará el cuadro de diálogo de consentimiento de OAuth después de que el usuario inicie sesión, solicitando al usuario que conceda permisos a la aplicación select_account: interrumpirá el inicio de sesión único y proporcionará una experiencia de selección de cuenta que muestre todas las cuentas en la sesión o en cualquier cuenta recordada o una opción para elegir usar una creación de cuenta diferente: dirigirá al usuario a la experiencia de creación de la cuenta en lugar de a la experiencia de inicio de sesión.
• account: AccountInfo obtenido de una API getAccount. Se usará en determinados escenarios para generar login_hint si no se proporcionan los parámetros loginHint y sid.
• loginHint: se puede usar para rellenar previamente el campo nombre de usuario o dirección de correo electrónico de la página de inicio de sesión para el usuario, si conoce la dirección de nombre de usuario o correo electrónico con antelación. A menudo, las aplicaciones usan este parámetro durante la re-autenticación, ya ha extraído el nombre de usuario de un inicio de sesión anterior mediante la notificación de preferred_username.
• sid: identificador de sesión, identificador único para la sesión. Disponible como notificación opcional en tokens de identificador.
• domainHint: proporciona una sugerencia sobre el inquilino o dominio que el usuario debe usar para iniciar sesión. El valor de la sugerencia de dominio es un dominio registrado para el inquilino.
• extraQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /authorize
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
• nonce: valor incluido en la solicitud que se devuelve en el token de identificador. Normalmente, se usa un valor único generado aleatoriamente para mitigar los ataques de reproducción.

Propiedades de respuesta que puede devolver el punto de conexión /authorize

Opciones específicas de AzureCloudInstance

• azureCloudInstance: enumeración de cadena que proporciona una notación corta para las autoridades de nube pública y de soverign
• tenant: aprovisionamiento para proporcionar la información del inquilino

Úselo para configurar las siguientes opciones de agente:

• nativeBrokerPlugin: implementación del agente nativo (se debe importar desde msal-node-extensions)

Nota: Estas opciones solo están disponibles para PublicClientApplications mediante el flujo de código de autorización

Almacén de valores de clave para la memoria caché en memoria

Úselo para configurar las siguientes opciones de configuración de caché:

• cachePlugin: complemento para leer y escribir caché de tokens en el disco.

CommonClientCredentialRequest

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso. Normalmente solo contiene el ámbito .default para un único recurso. Consulte: https://dotnet.territoriali.olinfo.it/azure/active-directory/develop/scopes-oidc#the-default-scope
• authority: dirección URL de la autoridad, el servicio de token de seguridad (STS) del que MSAL adquirirá tokens.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• skipCache: omita la búsqueda de la caché de tokens y obligue a la autoridad a obtener un nuevo token. El valor predeterminado es False.
• clientAssertion: una cadena de aserción o una función de devolución de llamada que devuelve una cadena de aserción (ambas son JWT firmados con codificación Base64Url) usadas en el flujo de credenciales de cliente.
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token

Usar el objeto de configuración para configurar MSAL e inicializar el objeto de aplicación cliente

• autenticación: aquí es donde se configuran elementos de autenticación como clientID, autoridad que se usa para autenticarse en la plataforma de identidad de Microsoft
• broker: aquí es donde se configuran las opciones de agente.
• cache: aquí es donde se configura la ubicación de caché.
• system: aquí es donde puede configurar el cliente de red, registrador
• telemetría: aquí es donde puede configurar las opciones de telemetría.

Parámetros para el flujo de código del dispositivo Oauth2.

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• authority: : dirección URL de la autoridad, el servicio de token de seguridad (STS) desde el que MSAL adquirirá tokens. Si la autoridad se establece en el objeto de aplicación cliente, esto invalidará ese valor. La invalidación del valor hará que la validación de la autoridad se produzca cada vez. Si se usará la misma autoridad para todas las solicitudes, establezca en el objeto de aplicación en lugar de las solicitudes.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• deviceCodeCallback: devolución de llamada que contiene la respuesta del código del dispositivo. El mensaje debe mostrarse al usuario final. Después, el usuario final puede ir a la verification_uri, escribir los user_code y las credenciales de entrada.
• cancel: booleano para cancelar el sondeo del punto de conexión de código de dispositivo. Mientras el usuario se autentica en un dispositivo independiente, MSAL sondea el punto de conexión de token del servicio de token de seguridad para el intervalo especificado en la respuesta de código del dispositivo (normalmente 15 minutos). Para detener el sondeo y cancelar la solicitud, establezca cancel=true.
• extraQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la cadena de consulta

Tipo que describe las notificaciones de token de identificador conocidas por MSAL.

Tipo intermitente para controlar objetos de datos en memoria con tipos definidos

Solicitar objeto pasado por el usuario para configurar acquireTokenInteractive API

• openBrowser: función para abrir una instancia del explorador en el sistema del usuario.
• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• successTemplate: plantilla que se va a mostrar en la instancia del explorador abierta tras la adquisición correcta del token.
• errorTemplate: plantilla que se va a mostrar en la instancia del explorador abierta tras un error de adquisición de tokens.
• windowHandle: se usa en flujos de agente nativos para primarios correctos de la ventana del agente nativo
• loopbackClient: implementación personalizada de un servidor de bucle invertido para escuchar la respuesta del código de autorización.

Formato de caché leído del blob de caché proporcionado a la configuración durante la creación de instancias de la aplicación

ManagedIdentityRequest

• claims: una solicitud de notificaciones con cadena que se usará para determinar si se debe omitir o no la memoria caché.
• forceRefresh: fuerza las solicitudes de identidad administradas para omitir la memoria caché y realizar llamadas de red si es true.
• resource: recurso solicitado para acceder a la API protegida. Debe tener el formato "ResourceIdUri" o "ResourceIdUri/.default". Por ejemplohttps://management.azure.net, o para Microsoft Graph,https://graph.microsoft.com/.default

Opciones permitidas por las API de solicitud de red.

• clientId: identificador de cliente de la aplicación.
• authority: dirección URL de la autoridad. Si no se establece ningún valor, el https://login.microsoftonline.com/commonvalor predeterminado es .
• knownAuthorities: se necesita para Azure B2C y ADFS. Todas las autoridades que se usarán en la aplicación cliente. Solo se debe pasar el host de la autoridad.
• clientSecret: cadena secreta que la aplicación usa al solicitar un token. Solo se usa en aplicaciones cliente confidenciales. Se puede crear en el portal de registro de aplicaciones de Azure.
• clientAssertion: objeto ClientAssertion que contiene una cadena de aserción o una función de devolución de llamada que devuelve una cadena de aserción que la aplicación usa al solicitar un token, así como el tipo de aserción (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Solo se usa en aplicaciones cliente confidenciales.
• clientCertificate: certificado que la aplicación usa al solicitar un token. Solo se usa en aplicaciones cliente confidenciales. Requiere la huella digital X.509 SHA-1 o SHA-256 codificada en hexadecimal del certificado y la clave privada codificada PEM (cadena debe contener -----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY----- )
• protocolMode: enumeración que representa el protocolo que sigue msal. Se usa para configurar los puntos de conexión adecuados.
• skipAuthorityMetadataCache: una marca para elegir si se va a usar o no la caché de metadatos locales durante la inicialización de la autoridad. El valor predeterminado es False.
• encodeExtraQueryParams: marca para elegir si se van a codificar parámetros de consulta adicionales en la dirección URL de la solicitud. El valor predeterminado es False.

Tipo para configurar el registrador y las opciones de cliente http

• registrador : se usa para inicializar el objeto Logger; TODO: expanda los detalles del registrador o vincule a la documentación sobre el registrador
• networkClient: cliente HTTP usado para todas las llamadas http get y post. El valor predeterminado es usar el cliente HTTP predeterminado de MSAL.

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• authority: dirección URL de la autoridad, el servicio de token de seguridad (STS) del que MSAL adquirirá tokens.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• oboAssertion: el token de acceso que se envió a la API de nivel intermedio. Este token debe tener una audiencia de la aplicación que realiza esta solicitud de OBO.
• skipCache: omita la búsqueda de la caché de tokens y obligue a la autoridad a obtener un nuevo token. El valor predeterminado es False.
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token

CommonRefreshTokenRequest

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• claims: una solicitud de notificaciones con cadena que se agregará a todas las llamadas /authorize y /token.
• authority: dirección URL de la autoridad, el servicio de token de seguridad (STS) del que MSAL adquirirá tokens.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• refreshToken: un token de actualización devuelto de una solicitud anterior al proveedor de identidades.
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
• forceCache: forzar a MSAL a almacenar en caché una respuesta de flujo de token de actualización cuando no hay ninguna cuenta en la memoria caché. Se usa para escenarios de migración.

Tipo de credencial de token de acceso

Tipo de cuenta

Tipo appMetadata

Tipo de credencial idtoken

Tipo de credencial de token de actualización

Parámetros silentFlow pasados por el usuario para recuperar credenciales de forma silenciosa

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• claims: una solicitud de notificaciones con cadena que se agregará a todas las llamadas /authorize y /token. Cuando se incluye en una solicitud silenciosa, se omitirá la búsqueda en caché y se actualizará el token.
• authority: dirección URL de la autoridad a la que la aplicación adquiere tokens.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
• account: entidad de cuenta para buscar las credenciales.
• forceRefresh: fuerza las solicitudes silenciosas para realizar llamadas de red si es true.

Parámetros UsernamePassword pasados por el usuario para recuperar credenciales Nota: El procedimiento actual de seguridad de OAuth 2.0 más reciente no permite la concesión de contraseña por completo. Este flujo se agrega para las pruebas internas.

• ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
• claims: una solicitud de notificaciones con cadena que se agregará a todas las llamadas /authorize y /token. Cuando se incluye en una solicitud silenciosa, se omitirá la búsqueda en caché y se actualizará el token.
• authority: dirección URL de la autoridad a la que la aplicación adquiere tokens.
• correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
• username: nombre de usuario del cliente
• password: credenciales
• tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token

Nivel de mensaje de registro.

Nombres de origen de identidad administrada

Modos de protocolo admitidos por MSAL.

valores permitidos para response_mode

Clase AuthErrorMessage que contiene constantes de cadena usadas por códigos de error y mensajes.

Constantes de cadena usadas por códigos de error y mensajes.

Clase ClientConfigurationErrorMessage que contiene constantes de cadena usadas por códigos de error y mensajes.

Errores necesarios de interacción definidos por el SDK

consideramos que esta "enumeración" se realiza en la solicitud en lugar de en la cadena; sin embargo, parece que la lista de valores de solicitud permitidas ha cambiado durante los últimos dos años. También hay algunos valores de solicitud no documentados para algunos asociados internos, por lo que la elección del tipo genérico "string" en lugar de la "enumeración"