@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:
|
| ActiveAccountFilters | |
| AppMetadataEntity |
Tipo de caché de metadatos de la aplicación |
| ApplicationTelemetry |
Información de telemetría enviada a petición
|
| AuthenticationResult |
Resultado devuelto desde el punto de conexión del token de la entidad.
|
| 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
|
| AzureRegion | |
| AzureRegionConfiguration | |
| BaseAuthRequest |
BaseAuthRequest
|
| CacheOptions |
Úselo para configurar las preferencias de caché de credenciales en el objeto ClientConfiguration
|
| 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)
|
| 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)
|
| CommonEndSessionRequest |
CommonEndSessionRequest
|
| CommonRefreshTokenRequest |
CommonRefreshTokenRequest
|
| CommonSilentFlowRequest |
Parámetros silentFlow pasados por el usuario para recuperar credenciales de forma silenciosa
|
| 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é.
|
| 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:
|
| LoggerOptions |
Úselo para configurar el registro que realiza MSAL, configurando las opciones del registrador en el objeto Configuration.
|
| 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.
En caso de error:
|
| 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
|
| 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.
|
| AppTokenProviderResult |
Objeto de salida para la extensiblidad de IAppTokenProvider.
|
| ClientAssertion |
Credenciales de aserción de cliente para clientes confidenciales |
| ClientAssertionCallback | |
| ClientAssertionConfig | |
| CommonClientCredentialRequest |
CommonClientCredentialRequest
|
| CommonDeviceCodeRequest |
Parámetros para el flujo de código del dispositivo Oauth2.
|
| CommonOnBehalfOfRequest |
|
| 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.
|
| 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.
|
| 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
| build |
|
| build |
Función para compilar un objeto de información de cliente a partir de la cadena clientInfo del servidor |
| build |
Función para compilar un objeto de información de cliente a partir de la cadena homeAccountId almacenada en caché |
| build |
|
| build |
Generar perfil de inquilino |
| create |
|
| create |
Función auxiliar para ajustar los errores del explorador en un objeto CacheError |
| create |
|
| create |
|
| create |
Crea un interactionRequiredAuthError |
| create |
Crea un objeto NetworkError para una solicitud de red con error. |
| format |
|
| get |
|
| get |
Obtiene tenantId de las notificaciones de token de identificador disponibles para establecer como dominio de credenciales con la siguiente prioridad:
|
| tenant |
Devuelve true si tenantId coincide con la parte utid de homeAccountId |
| update |
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
| AADAuthority |
Constantes de cadena relacionadas con la autoridad de AAD |
| Authentication |
Tipo de la solicitud de autenticación |
| Authority |
Tipos de autoridad admitidos por MSAL. |
| Azure |
|
| Cache |
Tipos de cuenta en caché |
| Cache |
Especifica el motivo para capturar el token de acceso del proveedor de identidades. |
| Cache |
Combinar todos los tipos de caché |
| Ccs |
|
| Claims |
Claves de solicitud de notificaciones |
| Credential |
Tipo de credencial almacenado en la memoria caché |
| Encoding |
|
| Grant |
grant_type permitidos |
| Header |
Nombres de encabezado de solicitud |
| Http |
|
| Http |
|
| Json |
|
| OAuth |
Valores permitidos para response_type |
| Password |
Parámetros de concesión de contraseña |
| Persistent |
Claves de caché persistentes MSAL que permanecen mientras el usuario ha iniciado sesión. |
| Protocol |
Modos de protocolo admitidos por MSAL. |
| Response |
valores permitidos para response_mode |
| Server |
valores permitidos para el tipo de respuesta del servidor |
| Auth |
Clase AuthErrorMessage que contiene constantes de cadena usadas por códigos de error y mensajes. |
| Client |
Constantes de cadena usadas por códigos de error y mensajes. |
| Client |
Clase ClientConfigurationErrorMessage que contiene constantes de cadena usadas por códigos de error y mensajes. |
| Code |
valores permitidos para codeVerifier |
| Constants | |
| DEFAULT_CRYPTO_IMPLEMENTATION | |
| DEFAULT_SYSTEM_OPTIONS | |
| DEFAULT_TOKEN_RENEWAL_OFFSET_SEC | |
| Errors | |
| Int |
|
| Interaction |
Errores necesarios de interacción definidos por el SDK |
| OIDC_DEFAULT_SCOPES | |
| ONE_DAY_IN_MS | |
| Prompt |
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" |
| Stubbed |
|
| THE_FAMILY_ID | |
| Throttling |
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:
- tid: si el token se adquiere a partir de un identificador de inquilino de AD de Azure estará presente.
- tfp: si el token se adquiere a partir de un tfp de inquilino B2C moderno debe estar presente.
- 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_SYSTEM_OPTIONS
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
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"