@azure/msal-common package

Clases

AuthError

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

AuthenticationHeaderParser

Se trata de una clase auxiliar que analiza los encabezados de autenticación de respuesta HTTP admitidos para extraer y devolver valores de desafío de encabezado que se pueden usar fuera de los flujos de autorización básicos.

CacheError

Error que se produce cuando se produce un error con la memoria caché

ClientAuthError

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

ClientConfigurationError

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

InteractionRequiredAuthError

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

Logger

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

NetworkError

Representa errores relacionados con la red.

PerformanceClient
PlatformBrokerError

Clase de error para errores en tiempo de ejecución de MSAL que conserva la información detallada del agente

ProtocolUtils

Clase que proporciona asistentes para valores específicos del protocolo OAuth 2.0

ScopeSet

La clase ScopeSet crea un conjunto de ámbitos. Los ámbitos no distinguen mayúsculas de minúsculas y valores únicos, por lo que el objeto Set de JS tiene más sentido implementar para esta clase. Todos los ámbitos se recortan y convierten en cadenas en minúsculas en las funciones de intersección y unión para garantizar la unicidad de las cadenas.

ServerError

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

StubPerformanceClient
UrlString

Clase de objeto URL que puede realizar varias transformaciones en cadenas de dirección URL.

TokenCacheContext

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.

Interfaces

ICrypto

Interfaz para funciones criptográficas usadas por la biblioteca

ILoggerCallback
INetworkModule

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

IPerformanceClient
IPerformanceMeasurement
IUri

Interfaz que describe los componentes de URI.

PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Alias de tipos

AccessTokenEntity

Tipo de caché de token de acceso

AccountFilter

Cuenta: <home_account_id-environment-realm<>><*>

AccountInfo

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
ActiveAccountFilters
AppMetadataEntity

Tipo de caché de metadatos de la aplicación

ApplicationTelemetry

Información de telemetría enviada a petición

  • appName: nombre de cadena único de una aplicación
  • appVersion: versión de la aplicación mediante MSAL
AuthenticationResult

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
AuthorityOptions
AuthorizationCodePayload

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

AuthorizeResponse

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

AzureCloudOptions

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
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • authority: dirección URL de la autoridad, el servicio de token de seguridad (STS) del que MSAL adquirirá tokens. Tiene como valor predeterminado https://login.microsoftonline.com/common. Si usa la misma autoridad para todas las solicitudes, la autoridad debe establecerse en el objeto de aplicación cliente y no en la solicitud, para evitar resolver puntos de conexión de autoridad varias veces.
  • correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
  • ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
  • authenticationScheme: el tipo de token recuperado. El valor predeterminado es "Bearer". También puede ser el tipo "pop" o "SSH".
  • claims: una solicitud de notificaciones con cadena que se agregará a todas las llamadas /authorize y /token.
  • shrClaims: un objeto de notificaciones con cadena que se agregará a una solicitud HTTP firmada.
  • shrNonce: marca de tiempo generada por el servidor que se ha cifrado y codificado en base64URL, que se agregará a una solicitud HTTP firmada.
  • shrOptions: un objeto que contiene opciones para la solicitud HTTP firmada
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
  • sshJwk: clave web JSON con cadena que representa una clave pública que puede firmar un certificado SSH.
  • sshKid: identificador de clave que identifica de forma única la clave pública SSH mencionada anteriormente.
  • azureCloudOptions: enumeraciones de cadena de conveniencia para que los usuarios proporcionen identificadores de nube pública o soberana
  • requestedClaimsHash: cadena hash SHA 256 de la cadena de notificaciones solicitada, que se usa como parte de una clave de caché de tokens de acceso para que los tokens se puedan filtrar mediante notificaciones solicitadas.
  • tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
  • tokenBodyParameters: cadena a la asignación de cadenas de parámetros personalizados agregados al cuerpo de la llamada /token
  • storeInCache: objeto que contiene valores booleanos que indican si se deben almacenar tokens en la memoria caché o no (el valor predeterminado es true)
  • scenarioId: id. de escenario para realizar un seguimiento de las solicitudes de usuario personalizadas
  • popKid: identificador de clave para identificar la clave pública para la solicitud de token de poP
  • embeddedClientId: identificador de cliente insertado. Cuando se especifica, los parámetros de id. de cliente de broker (brk_client_id) y URI de redirección (brk_redirect_uri) se establecen con valores de la configuración, reemplazando los parámetros adicionales correspondientes, si están presentes.
  • httpMethod: método HTTP que se va a usar para la solicitud /authorize. El valor predeterminado es GET, pero se puede establecer en POST si la solicitud requiere parámetros de cuerpo.
  • authorizePostBodyParameters: cadena a la asignación de cadenas de parámetros personalizados agregados al cuerpo de la llamada /authorize cuando httpMethod está establecido en POST
  • skipBrokerClaims: cuando se usa true y se usa un flujo asincrónico (por ejemplo, cuando hay parámetros de agente o un embeddedClientId), se excluirán clientCapabilities de la configuración de las notificaciones; se omite para los flujos no asincrónicas.
CacheOptions

Úselo para configurar las preferencias de caché de credenciales en el objeto ClientConfiguration

  • claimsBasedCachingEnabled: establece si los tokens se deben almacenar en caché en función del hash de notificaciones. El valor predeterminado es falso.
CcsCredential
ClientInfo

Objeto de información de cliente que consta de: uid: user id utid: id. de inquilino xms_tdbr: opcional, solo para inquilinos que no son de EE. UU.

CommonAuthorizationCodeRequest

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.
  • 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
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
  • enableSpaAuthCode: habilita la aclsición de un código de autorización de spa (solo clientes confidenciales)
  • tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
CommonAuthorizationUrlRequest

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 la experiencia de inicio de sesión no_session: no leerá el token de sesión existente al autenticar al usuario. Cuando el usuario se autentique correctamente, EVO no creará una nueva sesión para el usuario. SOLO PARA USO INTERNO.
  • 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.
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
CommonEndSessionRequest

CommonEndSessionRequest

  • account: objeto de cuenta del que se cerrará la sesión. Se borrarán todos los tokens vinculados a esta cuenta.
  • postLogoutRedirectUri: URI para ir a después de la página de cierre de sesión.
  • correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
  • idTokenHint: token de identificador usado por B2C para validar el cierre de sesión si es necesario en la directiva.
  • state: un valor incluido en la solicitud al punto de conexión de cierre de sesión que se devolverá en la cadena de consulta tras la redirección del cierre de sesión posterior al cierre de sesión.
  • logoutHint: una cadena que especifica la cuenta que se cierra la sesión para omitir el selector de cuentas de servidor en el cierre de sesión.
  • extraQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /authorize
CommonRefreshTokenRequest

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.
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
  • 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.
  • tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
CommonSilentFlowRequest

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.
  • account: entidad de cuenta para buscar las credenciales.
  • forceRefresh: fuerza las solicitudes silenciosas para realizar llamadas de red si es true.
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
  • tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
CredentialEntity

Tipo de caché de credenciales

CredentialFilter

Credencial: <home_account_id*>-<environment-credential_type-client_id-realm<>>><<*-<target*>>-<scheme*>

ExternalTokenResponse

Objeto de respuesta usado para cargar tokens externos para almacenar en caché.

  • token_type: indica el valor del tipo de token. El único tipo que Azure AD admite es Bearer.
  • scope: los ámbitos para los que el access_token es válido.
  • expires_in: cuánto tiempo es válido el token de acceso (en segundos).
  • id_token: un token web JSON (JWT). La aplicación puede descodificar los segmentos de este token para solicitar información sobre el usuario que ha iniciado sesión.
  • refresh_token: un token de actualización de OAuth 2.0. La aplicación puede usar este token para adquirir tokens de acceso adicionales después de que expire el token de acceso actual.
  • access_token: token de acceso solicitado. La aplicación puede usar este token para autenticarse en el recurso protegido, como una API web.
  • client_info: objeto de información de cliente
IdTokenEntity

Tipo de caché de token de identificador

InProgressPerformanceEvent
LibraryStateObject

Tipo que define el objeto con cadena, codificado y enviado en el valor de estado. Contiene lo siguiente:

  • id: identificador único para esta solicitud
  • ts: marca de tiempo para el momento en que se realizó la solicitud. Se usa para asegurarse de que la expiración del token no se calcula incorrectamente.
  • platformState: valor de cadena enviado desde la plataforma.
LoggerOptions

Úselo para configurar el registro que realiza MSAL, configurando las opciones del registrador en el objeto Configuration.

  • loggerCallback: devolución de llamada para el registrador
  • piiLoggingEnabled: establece si el registro pii está habilitado
  • logLevel: establece el nivel en el que se produce el registro.
  • correlationId: establece el correlationId impreso por el registrador.
NetworkRequestOptions

Opciones permitidas por las API de solicitud de red.

NetworkResponse
OIDCOptions

Opciones para el modo de protocolo OIDC.

PerformanceCallbackFunction
PerformanceEvent

Medición del rendimiento tomada por la biblioteca, incluidos los metadatos sobre la solicitud y la aplicación.

PkceCodes

El tipo PkceCodes describe la estructura de objetos que contienen pares de comprobación y desafío de código PKCE.

QueueMeasurement

Tipo de medida de cola

RefreshTokenEntity

Actualizar tipo de caché de tokens

RequestStateObject

Tipo que define el objeto con cadena y codificado enviado al servicio en la solicitud de autorización.

RequestThumbprint

Tipo que representa una huella digital de solicitud única.

ServerAuthorizationTokenResponse

Objeto de respuesta deserializado de la solicitud de código de autorización del servidor.

  • token_type: indica el valor del tipo de token. Puede ser Portador o pop.
  • scope: los ámbitos para los que el access_token es válido.
  • expires_in: cuánto tiempo es válido el token de acceso (en segundos).
  • refresh_in: duración que debe renovarse un token, independientemente de la expiración.
  • ext_expires_in: cuánto tiempo es válido el token de acceso (en segundos) si el servidor no responde.
  • access_token: token de acceso solicitado. La aplicación puede usar este token para autenticarse en el recurso protegido, como una API web.
  • refresh_token: un token de actualización de OAuth 2.0. La aplicación puede usar este token para adquirir tokens de acceso adicionales después de que expire el token de acceso actual.
  • id_token: un token web JSON (JWT). La aplicación puede descodificar los segmentos de este token para solicitar información sobre el usuario que ha iniciado sesión.
  • key_id: cadena que identifica de forma única una clave pública a la que está enlazada la solicitud.

En caso de error:

  • error: una cadena de código de error que se puede usar para clasificar los tipos de errores que se producen y se puede usar para reaccionar a los errores.
  • error_description: un mensaje de error específico que puede ayudar a un desarrollador a identificar la causa principal de un error de autenticación.
  • error_codes: lista de códigos de error específicos de STS que pueden ayudar en los diagnósticos.
  • timestamp: hora en la que se produjo el error.
  • trace_id: un identificador único para la solicitud que puede ayudar en los diagnósticos.
  • correlation_id: un identificador único para la solicitud que puede ayudar en el diagnóstico entre componentes.
  • status: estado de respuesta de la solicitud de red
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache

Controla si los tokens se deben almacenar en la memoria caché o no. Si se establece en false, es posible que los tokens se adquieran y devuelvan, pero no se almacenarán en caché para la recuperación posterior.

StringDict

Key-Value tipo para admitir queryParams, extraQueryParams y notificaciones

SubMeasurement
SystemOptions

Úselo para configurar la información de renovación de tokens en el objeto Configuration

  • tokenRenewalOffsetSeconds: establece la ventana de desplazamiento necesaria para renovar el token antes de la expiración.
TenantProfile

Detalles de la cuenta que varían entre inquilinos para el mismo usuario

ThrottlingEntity
TokenClaims

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

TokenKeys
AppTokenProviderParameters

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
AppTokenProviderResult

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.
ClientAssertion

Credenciales de aserción de cliente para clientes confidenciales

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • á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.
  • 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.
  • preferredAzureRegionOptions: opciones de la región de Azure preferida del usuario
  • tokenQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la llamada /token
CommonDeviceCodeRequest

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.
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
  • timeout: período de tiempo de espera en segundos que el usuario configura explícitamente para el sondeo del punto de conexión de código del dispositivo. Al final de este período; suponiendo que el código del dispositivo aún no ha expirado; El sondeo del código del dispositivo se detiene y se cancela la solicitud. La ventana de expiración del código de dispositivo siempre tendrá prioridad durante este período establecido.
  • extraQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la cadena de consulta
CommonOnBehalfOfRequest
  • á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
CommonUsernamePasswordRequest

Parámetros CommonUsernamePassword 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
DeviceCodeResponse

DeviceCode devuelto por el punto de conexión de código de dispositivo del servicio de token de seguridad que contiene información necesaria para el flujo de código del dispositivo.

  • userCode: código que el usuario debe proporcionar al autenticarse en el URI de comprobación
  • deviceCode: código que se debe incluir en la solicitud del token de acceso
  • verificationUri: URI donde el usuario puede autenticarse
  • expiresIn: hora de expiración del código del dispositivo en segundos
  • interval: intervalo en el que se debe sondear el STS
  • message: mensaje que se debe mostrar al usuario
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Enumeraciones

LogLevel

Nivel de mensaje de registro.

PerformanceEventStatus

Estado del evento de rendimiento.

PerformanceEvents

La enumeración de las operaciones instrumentadas por tienen su rendimiento medido por PerformanceClient.

Funciones

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)

Función para compilar un objeto de información de cliente a partir de la cadena clientInfo del servidor

buildClientInfoFromHomeAccountId(string)

Función para compilar un objeto de información de cliente a partir de la cadena homeAccountId almacenada en caché

buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)

Generar perfil de inquilino

createAuthError(string, string)
createCacheError(unknown)

Función auxiliar para ajustar los errores del explorador en un objeto CacheError

createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)

Crea un interactionRequiredAuthError

createNetworkError(AuthError, number, Record<string, string>, Error)

Crea un objeto NetworkError para una solicitud de red con error.

formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)

Obtiene tenantId de las notificaciones de token de identificador disponibles para establecer como dominio de credenciales con la siguiente prioridad:

  1. tid: si el token se adquiere a partir de un identificador de inquilino de AD de Azure estará presente.
  2. tfp: si el token se adquiere a partir de un tfp de inquilino B2C moderno debe estar presente.
  3. acr: si el token se adquiere a partir de un acr de inquilino B2C heredado debe estar presente downcased para que coincida con los requisitos de comparación que no distinguen mayúsculas de minúsculas del dominio.
tenantIdMatchesHomeTenant(string, string)

Devuelve true si tenantId coincide con la parte utid de homeAccountId

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Reemplaza la información de la cuenta que varía según el perfil de inquilino de origen de las notificaciones del token de identificador pasadas por la información de la cuenta específica del inquilino.

Variables

AADAuthorityConstants

Constantes de cadena relacionadas con la autoridad de AAD

AuthenticationScheme

Tipo de la solicitud de autenticación

AuthorityType

Tipos de autoridad admitidos por MSAL.

AzureCloudInstance
CacheAccountType

Tipos de cuenta en caché

CacheOutcome

Especifica el motivo para capturar el token de acceso del proveedor de identidades.

CacheType

Combinar todos los tipos de caché

CcsCredentialType
ClaimsRequestKeys

Claves de solicitud de notificaciones

CredentialType

Tipo de credencial almacenado en la memoria caché

EncodingTypes
GrantType

grant_type permitidos

HeaderNames

Nombres de encabezado de solicitud

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

Valores permitidos para response_type

PasswordGrantConstants

Parámetros de concesión de contraseña

PersistentCacheKeys

Claves de caché persistentes MSAL que permanecen mientras el usuario ha iniciado sesión.

ProtocolMode

Modos de protocolo admitidos por MSAL.

ResponseMode

valores permitidos para response_mode

ServerResponseType

valores permitidos para el tipo de respuesta del servidor

AuthErrorMessage

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

ClientAuthErrorMessage

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

ClientConfigurationErrorMessage

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

CodeChallengeMethodValues

valores permitidos para codeVerifier

Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage

Errores necesarios de interacción definidos por el SDK

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue

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"

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

Constantes relacionadas con la limitación

version

Detalles de la función

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

Parámetros

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims
TokenClaims
clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload
AuthorizationCodePayload
nativeAccountId

string

logger
Logger

Devoluciones

AccountEntity

buildClientInfo(string, (input: string) => string)

Función para compilar un objeto de información de cliente a partir de la cadena clientInfo del servidor

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

Parámetros

rawClientInfo

string

base64Decode

(input: string) => string

Devoluciones

buildClientInfoFromHomeAccountId(string)

Función para compilar un objeto de información de cliente a partir de la cadena homeAccountId almacenada en caché

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parámetros

homeAccountId

string

Devoluciones

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

Parámetros

authOptions

Partial<AuthorityOptions>

Devoluciones

buildTenantProfile(string, string, string, TokenClaims)

Generar perfil de inquilino

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

Parámetros

homeAccountId

string

Identificador de cuenta principal para este objeto de cuenta

localAccountId

string

Identificador de cuenta local para este objeto de cuenta

tenantId

string

Inquilino completo o identificador organizativo al que pertenece esta cuenta

idTokenClaims
TokenClaims

Notificaciones del token de identificador

Devoluciones

createAuthError(string, string)

function createAuthError(code: string, additionalMessage?: string): AuthError

Parámetros

code

string

additionalMessage

string

Devoluciones

createCacheError(unknown)

Función auxiliar para ajustar los errores del explorador en un objeto CacheError

function createCacheError(e: unknown): CacheError

Parámetros

e

unknown

Devoluciones

createClientAuthError(string, string)

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

Parámetros

errorCode

string

additionalMessage

string

Devoluciones

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parámetros

errorCode

string

Devoluciones

createInteractionRequiredAuthError(string)

Crea un interactionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parámetros

errorCode

string

Devoluciones

createNetworkError(AuthError, number, Record<string, string>, Error)

Crea un objeto NetworkError para una solicitud de red con error.

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

Parámetros

error
AuthError

Error al devolver al autor de la llamada

httpStatus

number

Código de estado de la solicitud de red

responseHeaders

Record<string, string>

Encabezados de respuesta de la solicitud de red, cuando estén disponibles

additionalError

Error

Devoluciones

NetworkError (objeto)

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parámetros

authorityUri

string

Devoluciones

string

getRequestThumbprint(string, BaseAuthRequest, string)

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

Parámetros

clientId

string

request
BaseAuthRequest
homeAccountId

string

Devoluciones

getTenantIdFromIdTokenClaims(TokenClaims)

Obtiene tenantId de las notificaciones de token de identificador disponibles para establecer como dominio de credenciales con la siguiente prioridad:

  1. tid: si el token se adquiere a partir de un identificador de inquilino de AD de Azure estará presente.
  2. tfp: si el token se adquiere a partir de un tfp de inquilino B2C moderno debe estar presente.
  3. acr: si el token se adquiere a partir de un acr de inquilino B2C heredado debe estar presente downcased para que coincida con los requisitos de comparación que no distinguen mayúsculas de minúsculas del dominio.
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Parámetros

idTokenClaims
TokenClaims

Devoluciones

string | null

tenantIdMatchesHomeTenant(string, string)

Devuelve true si tenantId coincide con la parte utid de homeAccountId

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

Parámetros

tenantId

string

homeAccountId

string

Devoluciones

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Reemplaza la información de la cuenta que varía según el perfil de inquilino de origen de las notificaciones del token de identificador pasadas por la información de la cuenta específica del inquilino.

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

Parámetros

baseAccountInfo
AccountInfo
tenantProfile
TenantProfile
idTokenClaims
TokenClaims
idTokenSecret

string

Devoluciones

Detalles de variables

AADAuthorityConstants

Constantes de cadena relacionadas con la autoridad de AAD

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

Tipo

{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

AuthenticationScheme

Tipo de la solicitud de autenticación

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

Tipo

{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

AuthorityType

Tipos de autoridad admitidos por MSAL.

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

Tipo

{ Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

AzureCloudInstance

AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

Tipo

{ AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

CacheAccountType

Tipos de cuenta en caché

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

Tipo

{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

CacheOutcome

Especifica el motivo para capturar el token de acceso del proveedor de identidades.

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

Tipo

{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

CacheType

Combinar todos los tipos de caché

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

Tipo

{ ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

CcsCredentialType

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

Tipo

{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

ClaimsRequestKeys

Claves de solicitud de notificaciones

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

Tipo

{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

CredentialType

Tipo de credencial almacenado en la memoria caché

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

Tipo

{ ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

EncodingTypes

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

Tipo

{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

GrantType

grant_type permitidos

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

Tipo

{ AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

HeaderNames

Nombres de encabezado de solicitud

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

Tipo

{ AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

HttpMethod

HttpMethod: { GET: "GET", POST: "POST" }

Tipo

{ GET: "GET", POST: "POST" }

HttpStatus

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

Tipo

{ BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

JsonWebTokenTypes

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

Tipo

{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

OAuthResponseType

Valores permitidos para response_type

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

Tipo

{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

PasswordGrantConstants

Parámetros de concesión de contraseña

PasswordGrantConstants: { password: "password", username: "username" }

Tipo

{ password: "password", username: "username" }

PersistentCacheKeys

Claves de caché persistentes MSAL que permanecen mientras el usuario ha iniciado sesión.

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

Tipo

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Modos de protocolo admitidos por MSAL.

ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

Tipo

{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

ResponseMode

valores permitidos para response_mode

ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

Tipo

{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

ServerResponseType

Advertencia

Esta API ya está en desuso.

Use ResponseMode instead

valores permitidos para el tipo de respuesta del servidor

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

Tipo

{ FRAGMENT: "fragment", QUERY: "query" }

AuthErrorMessage

Advertencia

Esta API ya está en desuso.

Use AuthErrorCodes instead

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

AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

Tipo

{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

ClientAuthErrorMessage

Advertencia

Esta API ya está en desuso.

Use ClientAuthErrorCodes instead

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

ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

Tipo

{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

ClientConfigurationErrorMessage

Advertencia

Esta API ya está en desuso.

Use ClientConfigurationErrorCodes instead

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

ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

Tipo

{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

CodeChallengeMethodValues

valores permitidos para codeVerifier

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Tipo

{ PLAIN: string, S256: string }

Constants

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

Tipo

{ AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Tipo

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Tipo

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Tipo

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Tipo

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Tipo

ReadonlySet<string>

InteractionRequiredAuthErrorMessage

Advertencia

Esta API ya está en desuso.

Use InteractionRequiredAuthErrorCodes instead

Errores necesarios de interacción definidos por el SDK

InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

Tipo

{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Tipo

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Tipo

86400000

PromptValue

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"

PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

Tipo

{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Tipo

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Tipo

"1"

ThrottlingConstants

Constantes relacionadas con la limitación

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

Tipo

{ DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

version

version: "15.17.0"

Tipo

"15.17.0"