@azure/msal-common package
Classes
| AuthError |
Classe de erro geral lançada pela biblioteca MSAL.js. |
| AuthenticationHeaderParser |
Esta é uma classe auxiliar que analisa cabeçalhos de autenticação de resposta HTTP suportados para extrair e devolver valores de desafio de cabeçalho que podem ser usados fora dos fluxos básicos de autorização. |
| CacheError |
Erro lançado quando há um erro na cache |
| ClientAuthError |
Erro lançado quando há um erro no código do cliente a correr no navegador. |
| ClientConfigurationError |
Erro lançado quando há um erro na configuração da biblioteca MSAL.js. |
| InteractionRequiredAuthError |
Erro lançado quando a interação do utilizador é necessária. |
| Logger |
Classe que facilita o registo de mensagens num local específico. |
| NetworkError |
Representa erros relacionados com a rede |
| PerformanceClient | |
| PlatformBrokerError |
Classe de erro para erros em tempo de execução MSAL que preserva informação detalhada do broker |
| ProtocolUtils |
que fornece auxiliares para valores específicos do protocolo OAuth 2.0 |
| ScopeSet |
A classe ScopeSet cria um conjunto de escopos. Os escopos são valores únicos e indiferentes a maiúsculas minúsculas, por isso o objeto Set em JS faz mais sentido implementar para esta classe. Todos os escopos são cortados e convertidos em cadeias minúsculas nas funções de interseção e união para garantir a unicidade das cadeias. |
| ServerError |
Erro lançado quando há um erro no código do servidor, por exemplo, indisponibilidade. |
| StubPerformanceClient | |
| UrlString |
A classe de objeto URL pode realizar várias transformações em strings de URL. |
| TokenCacheContext |
Esta instância de classe ajuda a acompanhar as alterações de memória, facilitando decisões para ler e escrever na cache persistente |
Interfaces
| ICrypto |
Interface para funções criptográficas usadas pela biblioteca |
| ILoggerCallback | |
| INetworkModule |
Interface de rede cliente para enviar pedidos de backend. |
| IPerformanceClient | |
| IPerformanceMeasurement | |
| IUri |
Interface que descreve os componentes do URI. |
| PreQueueEvent | |
| IAppTokenProvider | |
| ICachePlugin | |
| IGuidGenerator | |
| INativeBrokerPlugin | |
| ISerializableTokenCache | |
Aliases de Tipo
| AccessTokenEntity |
Tipo de cache de token de acesso |
| AccountFilter |
Relato: <home_account_id-reino-ambiente<><>*> |
| AccountInfo |
Objeto de conta com a seguinte assinatura:
|
| ActiveAccountFilters | |
| AppMetadataEntity |
Tipo de Cache de Metadados da Aplicação |
| ApplicationTelemetry |
Informação de telemetria enviada mediante pedido
|
| AuthenticationResult |
Resultado devolvido do endpoint do token da autoridade.
|
| AuthorityOptions | |
| AuthorizationCodePayload |
Resposta retornada após processar a cadeia de resposta ou fragmento da consulta de resposta. |
| AuthorizeResponse |
Propriedades de resposta que podem ser devolvidas pelo endpoint /authorize |
| AzureCloudOptions |
Opções específicas do AzureCloudInstance
|
| AzureRegion | |
| AzureRegionConfiguration | |
| BaseAuthRequest |
BaseAuthRequest
|
| CacheOptions |
Use isto para configurar as preferências da cache de credenciais no objeto ClientConfiguration
|
| CcsCredential | |
| ClientInfo |
Objeto de informação do cliente que consiste em: uid: user id utid: tenant id xms_tdbr: opcional, apenas para inquilinos fora dos EUA |
| CommonAuthorizationCodeRequest |
Objeto de pedido passado pelo utilizador para adquirir um token do servidor trocando um código de autorização válido (segunda perna do fluxo de código de autorização OAuth2.0)
|
| CommonAuthorizationUrlRequest |
Objeto de pedido passado pelo utilizador para recuperar um Código do servidor (primeira etapa do fluxo de concessão do código de autorização)
|
| CommonEndSessionRequest |
PedidoCommonEndSession
|
| CommonRefreshTokenRequest |
CommonRefreshTokenRequest
|
| CommonSilentFlowRequest |
Parâmetros SilentFlow passados pelo utilizador para obter credenciais silenciosamente
|
| CredentialEntity |
Tipo de Cache de Credencial |
| CredentialFilter |
Credencial: <home_account_id*>-<ambiente-credential_type-client_id-reino<<>><>*>-<alvo*>-<esquema*> |
| ExternalTokenResponse |
Objeto de resposta usado para carregar tokens externos em cache.
|
| IdTokenEntity |
Tipo de Cache de Token de Id |
| InProgressPerformanceEvent | |
| LibraryStateObject |
Tipo que define o objeto que é stringificado, codificado e enviado no valor de estado. Contém o seguinte:
|
| LoggerOptions |
Use isto para configurar o registo que o MSAL faz, configurando opções de registo no objeto Configuração
|
| NetworkRequestOptions |
Opções permitidas por APIs de pedidos de rede. |
| NetworkResponse | |
| OIDCOptions |
Opções para o modo protocolo OIDC. |
| PerformanceCallbackFunction | |
| PerformanceEvent |
Medição de desempenho realizada pela biblioteca, incluindo metadados sobre o pedido e a aplicação. |
| PkceCodes |
O tipo PkceCodes descreve a estrutura de objetos que contêm pares de desafio e verificador de código PKCE |
| QueueMeasurement |
Tipo de medição de fila |
| RefreshTokenEntity |
Tipo de Cache de Token de Atualização |
| RequestStateObject |
Tipo que define o objeto stringificado e codificado enviado ao serviço no pedido de autorização. |
| RequestThumbprint |
O tipo representa uma impressão digital única do pedido. |
| ServerAuthorizationTokenResponse |
Objeto de resposta deserializado do pedido de código de autorização do servidor.
Em caso de erro:
|
| ServerTelemetryEntity | |
| ServerTelemetryRequest | |
| ShrOptions | |
| SignedHttpRequest | |
| SignedHttpRequestParameters | |
| StaticAuthorityOptions | |
| StoreInCache |
Controla se os tokens devem ser armazenados na cache ou não. Se definido como falso, os tokens podem ainda ser adquiridos e devolvidos, mas não serão armazenados em cache para recuperação posterior. |
| StringDict |
Key-Value tipo para suportar queryParams, extraQueryParams e reivindicações |
| SubMeasurement | |
| SystemOptions |
Use isto para configurar a informação de renovação de tokens no objeto Configuração
|
| TenantProfile |
Detalhes da conta que variam entre inquilinos para o mesmo utilizador |
| ThrottlingEntity | |
| TokenClaims |
Tipo que descreve as reivindicações do Id Token conhecidas pela MSAL. |
| TokenKeys | |
| AppTokenProviderParameters |
Objeto de entrada para a extensibilidade IAppTokenProvider. A MSAL irá criar este objeto, que pode ser usado para ajudar a criar um AppTokenProviderResult.
|
| AppTokenProviderResult |
Objeto de saída para extensibilidade IAppTokenProvider.
|
| ClientAssertion |
Credencial de Declaração de Cliente para Clientes Confidenciais |
| ClientAssertionCallback | |
| ClientAssertionConfig | |
| CommonClientCredentialRequest |
PedidoCredencial ComumCliente
|
| CommonDeviceCodeRequest |
Parâmetros para o fluxo de código do dispositivo Oauth2.
|
| CommonOnBehalfOfRequest |
|
| CommonUsernamePasswordRequest |
Parâmetros CommonUsernamePassword passados pelo utilizador para obter credenciais Nota: A mais recente Prática Atual de Segurança OAuth 2.0 impede totalmente a concessão de palavra-passe. Este fluxo é adicionado para testes internos.
|
| DeviceCodeResponse |
O DeviceCode é devolvido pelo endpoint do código do dispositivo do serviço de token de segurança, contendo informações necessárias para o fluxo do código do dispositivo.
|
| NativeRequest | |
| NativeSignOutRequest | |
| ServerDeviceCodeResponse | |
Enumerações
| LogLevel |
Registar o nível da mensagem. |
| PerformanceEventStatus |
Estado do evento de atuação. |
| PerformanceEvents |
A enumeração das operações instrumentadas por tem o seu desempenho medido pelo PerformanceClient. |
Funções
| build |
|
| build |
Função para construir um objeto info cliente a partir da string serverClientInfo |
| build |
Função para construir um objeto de informação cliente a partir da cadeia homeAccountId em cache |
| build |
|
| build |
Perfil do inquilino da construção |
| create |
|
| create |
Função auxiliar para envolver erros do navegador num objeto CacheError |
| create |
|
| create |
|
| create |
Cria um InteractionRequiredAuthError |
| create |
Cria o objeto NetworkError para um pedido de rede falhado |
| format |
|
| get |
|
| get |
Obtém o tenantId do token ID disponível reivindica ser definido como reino de credencial com a seguinte precedência:
|
| tenant |
Retorna verdadeiro se o tenantId corresponder à parte utid do homeAccountId |
| update |
Substitui a informação da conta que varia consoante o perfil do inquilino, proveniente das reclamações do ID token entregues, pela informação específica da conta do inquilino |
Variáveis
| AADAuthority |
Constantes de cadeia relacionadas com a Autoridade AAD |
| Authentication |
Tipo do pedido de autenticação |
| Authority |
Tipos de autoridade suportados pelo MSAL. |
| Azure |
|
| Cache |
Tipos de conta na Cache |
| Cache |
Especifica a razão para obter o token de acesso junto do fornecedor de identidade |
| Cache |
Combinar todos os tipos de cache |
| Ccs |
|
| Claims |
Chaves de pedido de sinistros |
| Credential |
Tipo de Credencial armazenado na cache |
| Encoding |
|
| Grant |
permitido grant_type |
| Header |
Nomes dos cabeçalhos do pedido |
| Http |
|
| Http |
|
| Json |
|
| OAuth |
Valores permitidos para response_type |
| Password |
Parâmetros de concessão de palavra-passe |
| Persistent |
Chaves persistentes de cache MSAL que permanecem enquanto o utilizador está logado. |
| Protocol |
Modos de protocolo suportados pelo MSAL. |
| Response |
valores permitidos para response_mode |
| Server |
Valores permitidos para o tipo de resposta do servidor |
| Auth |
AuthErrorMessage classe contendo constantes de cadeia usadas por códigos de erro e mensagens. |
| Client |
Constantes de cadeia usadas por códigos de erro e mensagens. |
| Client |
A classe ClientConfigurationErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens. |
| Code |
valores permitidos para codeVerifier |
| Constants | |
| DEFAULT_CRYPTO_IMPLEMENTATION | |
| DEFAULT_SYSTEM_OPTIONS | |
| DEFAULT_TOKEN_RENEWAL_OFFSET_SEC | |
| Errors | |
| Int |
|
| Interaction |
Interação requeria erros definidos pelo SDK |
| OIDC_DEFAULT_SCOPES | |
| ONE_DAY_IN_MS | |
| Prompt |
Considerámos colocar este "enum" no pedido em vez de uma cadeia, no entanto, parece que a lista permitida de valores do prompt tem mudado nos últimos anos. Existem também alguns valores de prompt não documentados para alguns parceiros internos, daí a escolha do tipo genérico de "string" em vez do "enum" |
| Stubbed |
|
| THE_FAMILY_ID | |
| Throttling |
Constantes relacionadas com a limitação |
| version |
Detalhes de Função
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
Devoluções
AccountEntity
buildClientInfo(string, (input: string) => string)
Função para construir um objeto info cliente a partir da string serverClientInfo
function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo
Parâmetros
- rawClientInfo
-
string
- base64Decode
-
(input: string) => string
Devoluções
buildClientInfoFromHomeAccountId(string)
Função para construir um objeto de informação cliente a partir da cadeia homeAccountId em cache
function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo
Parâmetros
- homeAccountId
-
string
Devoluções
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions
Parâmetros
- authOptions
-
Partial<AuthorityOptions>
Devoluções
buildTenantProfile(string, string, string, TokenClaims)
Perfil do inquilino da construção
function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile
Parâmetros
- homeAccountId
-
string
Identificador de conta inicial para este objeto de conta
- localAccountId
-
string
Identificador de conta local para este objeto de conta
- tenantId
-
string
Inquilino completo ou ID organizacional a que esta conta pertence
- idTokenClaims
- TokenClaims
Reivindicações do ID token
Devoluções
createAuthError(string, string)
function createAuthError(code: string, additionalMessage?: string): AuthError
Parâmetros
- code
-
string
- additionalMessage
-
string
Devoluções
createCacheError(unknown)
Função auxiliar para envolver erros do navegador num objeto CacheError
function createCacheError(e: unknown): CacheError
Parâmetros
- e
-
unknown
Devoluções
createClientAuthError(string, string)
function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError
Parâmetros
- errorCode
-
string
- additionalMessage
-
string
Devoluções
createClientConfigurationError(string)
function createClientConfigurationError(errorCode: string): ClientConfigurationError
Parâmetros
- errorCode
-
string
Devoluções
createInteractionRequiredAuthError(string)
Cria um InteractionRequiredAuthError
function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError
Parâmetros
- errorCode
-
string
Devoluções
createNetworkError(AuthError, number, Record<string, string>, Error)
Cria o objeto NetworkError para um pedido de rede falhado
function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError
Parâmetros
- error
- AuthError
Erro a ser devolvido ao chamador
- httpStatus
-
number
Código de estado do pedido de rede
- responseHeaders
-
Record<string, string>
Cabeçalhos de resposta do pedido de rede, quando disponíveis
- additionalError
-
Error
Devoluções
Objeto NetworkError
formatAuthorityUri(string)
function formatAuthorityUri(authorityUri: string): string
Parâmetros
- authorityUri
-
string
Devoluções
string
getRequestThumbprint(string, BaseAuthRequest, string)
function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint
Parâmetros
- clientId
-
string
- request
- BaseAuthRequest
- homeAccountId
-
string
Devoluções
getTenantIdFromIdTokenClaims(TokenClaims)
Obtém o tenantId do token ID disponível reivindica ser definido como reino de credencial com a seguinte precedência:
- tid - se o token for adquirido de um tenant do Azure AD, o tid estará presente
- tfp - se o token for adquirido de um inquilino B2C moderno, o tfp deve estar presente
- acr - se o token for adquirido de um inquilino B2C legado, acr deve estar presente em Downcaseed para corresponder aos requisitos de comparação insensíveis a maiúsculas e minúsculas
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null
Parâmetros
- idTokenClaims
- TokenClaims
Devoluções
string | null
tenantIdMatchesHomeTenant(string, string)
Retorna verdadeiro se o tenantId corresponder à parte utid do homeAccountId
function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean
Parâmetros
- tenantId
-
string
- homeAccountId
-
string
Devoluções
boolean
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)
Substitui a informação da conta que varia consoante o perfil do inquilino, proveniente das reclamações do ID token entregues, pela informação específica da conta do inquilino
function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo
Parâmetros
- baseAccountInfo
- AccountInfo
- tenantProfile
- TenantProfile
- idTokenClaims
- TokenClaims
- idTokenSecret
-
string
Devoluções
Detalhes das variáveis
AADAuthorityConstants
Constantes de cadeia relacionadas com a Autoridade AAD
AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }
Tipo
{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }
AuthenticationScheme
Tipo do pedido de autenticação
AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }
Tipo
{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }
AuthorityType
Tipos de autoridade suportados pelo 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 conta na Cache
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 a razão para obter o token de acesso junto do fornecedor de identidade
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 os tipos de cache
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
Chaves de pedido de sinistros
ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }
Tipo
{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }
CredentialType
Tipo de Credencial armazenado na cache
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
permitido grant_type
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
Nomes dos cabeçalhos do pedido
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 concessão de palavra-passe
PasswordGrantConstants: { password: "password", username: "username" }
Tipo
{ password: "password", username: "username" }
PersistentCacheKeys
Chaves persistentes de cache MSAL que permanecem enquanto o utilizador está logado.
PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }
Tipo
{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }
ProtocolMode
Modos de protocolo suportados pelo 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
Aviso
Esta API foi preterida.
Use ResponseMode instead
Valores permitidos para o tipo de resposta do servidor
ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }
Tipo
{ FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Aviso
Esta API foi preterida.
Use AuthErrorCodes instead
AuthErrorMessage classe contendo constantes de cadeia usadas por códigos de erro e mensagens.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Tipo
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Aviso
Esta API foi preterida.
Use ClientAuthErrorCodes instead
Constantes de cadeia usadas por códigos de erro e mensagens.
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
Aviso
Esta API foi preterida.
Use ClientConfigurationErrorCodes instead
A classe ClientConfigurationErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens.
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
Aviso
Esta API foi preterida.
Use InteractionRequiredAuthErrorCodes instead
Interação requeria erros definidos pelo 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
Considerámos colocar este "enum" no pedido em vez de uma cadeia, no entanto, parece que a lista permitida de valores do prompt tem mudado nos últimos anos. Existem também alguns valores de prompt não documentados para alguns parceiros internos, daí a escolha do tipo genérico de "string" em vez do "enum"
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 com a limitação
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"