@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:

  • homeAccountId - Identificador da conta principal para este objeto de conta
  • ambiente - Entidade que emitiu o token representado pelo domínio do emissor (por exemplo, login.microsoftonline.com)
  • TenantId - Tenant completo ou ID organizacional a que esta conta pertence
  • Nome de utilizador - preferred_username reivindicação da id_token que representa esta conta
  • localAccountId - Identificador de conta local, específico do inquilino para este objeto de conta, geralmente usado em casos legados
  • nome - Nome completo da conta, incluindo nome próprio e apelido
  • idToken - token de identificação bruto
  • idTokenClaims - O objeto contém reivindicações do ID token
  • nativeAccountId - O ID nativo da conta do utilizador
  • TenantProfiles - Mapa dos objetos de perfil de inquilino para cada inquilino com que a conta se autenticou no navegador
  • dataBoundary - Fronteira de dados extraída do clienteInfo
ActiveAccountFilters
AppMetadataEntity

Tipo de Cache de Metadados da Aplicação

ApplicationTelemetry

Informação de telemetria enviada mediante pedido

  • appName: Nome único da cadeia de uma aplicação
  • appVersion: Versão da aplicação que utiliza MSAL
AuthenticationResult

Resultado devolvido do endpoint do token da autoridade.

  • uniqueId - oid ou sub reivindicação a partir do token ID
  • tenantId - tid reclamação a partir do token ID
  • escopos - Escopos validados para o respetivo token
  • conta - Uma representação de objeto conta do utilizador atualmente iniciado
  • idToken - Token ID recebido como parte da resposta
  • idTokenClaims - Reivindicações de ID token relevantes para MSAL
  • accessToken - Token de acesso ou certificado SSH recebido como parte da resposta
  • fromCache - Booleano que indica se o token veio da cache
  • expiresOn - Objeto Data Javascript representando a expiração relativa do token de acesso
  • extExpiresOn - Objeto Data Javascript que representa a expiração relativa estendida do token de acesso em caso de falha do servidor
  • refreshOn - Objeto Data Javascript representando o tempo relativo até que um token de acesso tenha de ser atualizado
  • estado - Valor passado pelo utilizador a pedido
  • familyId - Identificador de Family ID, normalmente usado apenas para tokens de atualização
  • requestId - ID do pedido devolvido como parte da resposta
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

  • azureCloudInstance - string enum que fornece notação curta para autoridades de soverign e cloud pública
  • Inquilino - Cláusula para fornecer informações ao inquilino
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • autoridade - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir os tokens. O valor padrão é https://login.microsoftonline.com/common. Se for usada a mesma autoridade para todos os pedidos, a autoridade deve ser definida como objeto de aplicação cliente e não como pedido, para evitar resolver os endpoints de autoridade várias vezes.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • authenticationScheme - O tipo de token recuperado. Por defeito, "Bearer". Também pode ser tipo "pop" ou "SSH".
  • claims - Um pedido de claims stringified que será adicionado a todas as chamadas /authorize e /token
  • shrClaims - Um objeto de reivindicações stringificadas que será adicionado a um Pedido HTTP Assinado
  • shrNonce - Um carimbo temporal gerado pelo servidor que foi encriptado e codificado base64URL, que será adicionado a um Pedido HTTP Assinado.
  • shrOptions - Um objeto contendo opções para o Pedido HTTP Assinado
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
  • sshJwk - Uma Web Key JSON stringificada que representa uma chave pública que pode ser assinada por um certificado SSH.
  • sshKid - ID de chave que identifica de forma única a chave pública SSH mencionada acima.
  • azureCloudOptions - Enums de string de conveniência para utilizadores fornecerem IDs de cloud públicos/soberanos
  • requestedClaimsHash - Cadeia de hash SHA 256 da cadeia de reivindicações solicitadas, usada como parte de uma chave de cache de token de acesso para que os tokens possam ser filtrados pelas reivindicações solicitadas
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
  • tokenBodyParameters - Mapa de string para string de parâmetros personalizados adicionados ao corpo da chamada /token
  • storeInCache - Objeto contendo valores booleanos que indicam se deve ou não armazenar tokens na cache (o padrão é verdadeiro)
  • scenarioId - Scenario ID para acompanhar prompts personalizados do utilizador
  • popKid - ID de chave para identificar a chave pública para pedido de token PoP
  • EmbeddedClientId - ID de cliente embebidido. Quando especificados, os parâmetros id do cliente do corredor (brk_client_id) e o uri de redirecionamento (brk_redirect_uri) são definidos com valores da configuração, sobrepondo-se aos parâmetros extra correspondentes, se existirem.
  • httpMethod - Método HTTP a usar para o pedido /authorize. Define por defeito GET, mas pode ser definido para POST se o pedido exigir parâmetros do corpo
  • authorizePostBodyParameters - Mapa de string para string de parâmetros personalizados adicionados ao corpo da chamada /authorize quando httpMethod está definido como POST
  • skipBrokerClaims - Quando verdadeiro e um fluxo intermediado é utilizado (por exemplo, quando parâmetros do corredor ou um ClientId embedded estão presentes), as ClientCapabilities da configuração serão excluídas das reclamações; Ignorado para fluxos não intermediados.
CacheOptions

Use isto para configurar as preferências da cache de credenciais no objeto ClientConfiguration

  • claimsBasedCachingEnabled - Define se os tokens devem ser armazenados em cache com base no hash das reivindicações. O valor padrão é falso.
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)

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • claims - Um pedido de claims stringified que será adicionado a todas as chamadas /authorize e /token
  • autoridade: - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir tokens. Se a authority for definida no objeto da aplicação cliente, esta irá sobrepor esse valor. Sobrepor o valor fará com que a validação da autoridade aconteça cada vez. Se a mesma autoridade for usada para todos os pedidos, defina o objeto de aplicação em vez dos pedidos.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • redirectUri - O URI de redirecionamento da sua aplicação, para onde a autoridade irá redirecionar depois do utilizador introduzir credenciais e consentir. Deve corresponder exatamente a um dos URIs de redirecionamento que registou no portal
  • código - O authorization_code que o utilizador adquiriu na primeira etapa do fluxo.
  • codeVerifier - O mesmo code_verifier que foi usado para obter a authorization_code. Obrigatório se o PKCE foi usado no pedido de concessão do código de autorização. Para mais informações, consulte o PKCE RFC: https://tools.ietf.org/html/rfc7636
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
  • enableSpaAuthCode - Permite a aquisição de um código de autorização de spa (apenas clientes confidenciais)
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
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)

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • claims - Um pedido de claims stringified que será adicionado a todas as chamadas /authorize e /token
  • autoridade - URL da autoridade da qual a aplicação adquire os tokens.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • redirectUri - O URI de redirecionamento onde a sua aplicação pode receber respostas de autenticação. Deve corresponder exatamente a um dos URIs de redirecionamento registados no portal Azure.
  • extraScopesToConsent - Escopos para um recurso diferente quando o utilizador precisa de consentimento antecipado.
  • responseMode - Especifica o método que deve ser usado para enviar o resultado de autenticação à sua aplicação. Pode ser consulta, form_post ou fragmento. Se não for passado nenhum valor, por defeito passa para a consulta.
  • codeChallenge - Usado para garantir a concessão de código de autorização via Proof of Key for Code Exchange (PKCE). Para mais informações, consulte o PKCE RCF:https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod - O método usado para codificar o verificador de código para o parâmetro de desafio de código. Pode ser "simples" ou "S256". Se excluído, o desafio de código assume-se que é texto simples. Para mais informações, consulte o PKCE RCF: https://tools.ietf.org/html/rfc7636
  • estado - Um valor incluído no pedido que também é devolvido na resposta do token. Um valor único gerado aleatoriamente é normalmente usado para prevenir ataques de falsificação de pedidos entre sites. O estado também é usado para codificar informações sobre o estado do utilizador na aplicação antes do pedido de autenticação ocorrer.
  • prompt - Indica o tipo de interação do utilizador necessária. Login: Vai forçar o utilizador a introduzir as suas credenciais nesse pedido, anulando o single-sign on nenhum: Garante que o utilizador não recebe nenhum prompt interativo. Se o pedido não puder ser concluído via Single-Logon, o endpoint devolverá um interaction_required Consentimento de Erro: Será que o Diálogo de Consentimento OAuth será ativado após o utilizador iniciar sessão, pedindo permissões à aplicação select_account: irá interromper o Single Sign-=ao fornecer experiência de seleção de conta listando todas as contas em sessão ou quaisquer contas memorizadas ou uma opção para escolher usar uma conta diferente Criar: irá direcionar o utilizador para a experiência de criação da conta em vez da experiência de início de sessão no_session: não lê o token de sessão existente ao autenticar o utilizador. Após o utilizador ser autenticado com sucesso, o EVO não criará uma nova sessão para o utilizador. APENAS PARA USO INTERNO.
  • conta - AccountInfo obtido a partir de uma API getAccount. Será usado em certos cenários para gerar login_hint se não forem fornecidos os parâmetros loginHint e sid.
  • loginDica - Pode ser usado para pré-preencher o campo de nome de utilizador/endereço de email da página de início de sessão do utilizador, se souber o nome de utilizador/endereço de email antecipadamente. Frequentemente, as aplicações usam este parâmetro durante a reautenticação, tendo já extraído o nome de utilizador de um login anterior usando a reivindicação preferred_username.
  • sid - ID da sessão, identificador único para a sessão. Disponível como reivindicação opcional em ID tokens.
  • DomainHint - Fornece uma dica sobre o inquilino ou domínio que o utilizador deve usar para iniciar sessão. O valor da dica de domínio é um domínio registado para o inquilino.
  • extraQueryParameters - Mapa de string para string de parâmetros personalizados de consulta adicionados à chamada /authorize
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
  • nonce - Um valor incluído no pedido que é devolvido no token id. Um valor único gerado aleatoriamente é normalmente usado para mitigar ataques de repetição.
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
CommonEndSessionRequest

PedidoCommonEndSession

  • account - Objeto de conta do qual será desconectado. Todos os tokens ligados a esta conta serão compensados.
  • postLogoutRedirectUri - URI para navegar após a página de logout.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • idTokenHint - ID Token usado pelo B2C para validar a saída de logout se exigido pela política
  • estado - Um valor incluído no pedido ao endpoint de logout que será devolvido na cadeia de consulta após a redireção pós-logout
  • logoutHint - Uma cadeia que especifica a conta que está a ser deslogada para que se possa saltar o seletor de contas do servidor ao sair
  • extraQueryParameters - Mapa de string para string de parâmetros personalizados de consulta adicionados à chamada /authorize
CommonRefreshTokenRequest

CommonRefreshTokenRequest

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • claims - Um pedido de claims stringified que será adicionado a todas as chamadas /authorize e /token
  • autoridade - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir os tokens.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • refreshToken - Um token de refresh devolvido de um pedido anterior ao fornecedor de Identidade.
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
  • forceCache - Forçar o MSAL a armazenar em cache uma resposta de fluxo de token de atualização quando não há conta na cache. Usado para cenários de migração.
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
CommonSilentFlowRequest

Parâmetros SilentFlow passados pelo utilizador para obter credenciais silenciosamente

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • claims - Um pedido de claims stringified que será adicionado a todas as chamadas /authorize e /token. Quando incluído num pedido silencioso, a pesquisa de cache será ignorada e o token será atualizado.
  • autoridade - URL da autoridade da qual a aplicação adquire os tokens.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • conta - Entidade da conta para consultar as credenciais.
  • forceRefresh - Força pedidos silenciosos a fazer chamadas de rede, se for verdade.
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
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.

  • token_type: Indica o valor do tipo de token. O único tipo que o Azure AD suporta é o Portador.
  • Âmbito: Os parâmetros para os quais o access_token é válido.
  • expires_in: Quanto tempo o token de acesso é válido (em segundos).
  • id_token: Um Token Web JSON (JWT). O aplicativo pode decodificar os segmentos desse token para solicitar informações sobre o usuário que fez login.
  • refresh_token: Um token de atualização OAuth 2.0. A aplicação pode, usando este token, adquirir tokens de acesso adicionais após expirar o token de acesso atual.
  • access_token: O token de acesso solicitado. O aplicativo pode usar esse token para autenticar o recurso seguro, como uma API da Web.
  • client_info: Objeto de informação do cliente
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:

  • ID - Identificador único para este pedido
  • TS - Carimbo temporal do momento em que o pedido foi feito. Usado para garantir que a expiração do token não é calculada incorretamente.
  • platformState - valor de string enviado pela plataforma.
LoggerOptions

Use isto para configurar o registo que o MSAL faz, configurando opções de registo no objeto Configuração

  • loggerCallback - Callback para logger
  • piiLoggingEnabled - Define se o registo PII está ativado
  • logLevel - Define o nível em que o registo ocorre
  • correlationId - Define o correlationId impresso pelo logger
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.

  • token_type: Indica o valor do tipo de token. Pode ser Bearer ou pop.
  • Âmbito: Os parâmetros para os quais o access_token é válido.
  • expires_in: Quanto tempo o token de acesso é válido (em segundos).
  • refresh_in: Duração após a qual um token deve ser renovado, independentemente da expiração.
  • ext_expires_in: Quanto tempo o token de acesso é válido (em segundos) se o servidor não estiver a responder.
  • access_token: O token de acesso solicitado. O aplicativo pode usar esse token para autenticar o recurso seguro, como uma API da Web.
  • refresh_token: Um token de atualização OAuth 2.0. A aplicação pode, usando este token, adquirir tokens de acesso adicionais após expirar o token de acesso atual.
  • id_token: Um Token Web JSON (JWT). O aplicativo pode decodificar os segmentos desse token para solicitar informações sobre o usuário que fez login.
  • key_id: Uma cadeia que identifica de forma única uma chave pública à qual o pedido está vinculado.

Em caso de erro:

  • Erro: Uma cadeia de código de erro que pode ser usada para classificar tipos de erros que ocorrem e pode ser usada para reagir a erros.
  • error_description: Uma mensagem de erro específica que pode ajudar um programador a identificar a causa raiz de um erro de autenticação.
  • error_codes: Uma lista de códigos de erro específicos para STS que podem ajudar no diagnóstico.
  • carimbo temporal: A hora em que o erro ocorreu.
  • trace_id: Um identificador único para o pedido que pode ajudar no diagnóstico.
  • correlation_id: Um identificador único para o pedido que pode ajudar no diagnóstico entre componentes.
  • Estado: Estado de resposta ao pedido de rede
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

  • tokenRenewalOffsetSeconds - Define a janela de offset necessária para renovar o token antes do vencimento
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.

  • correlationId - o Id de correlação associado ao pedido
  • tenantId - o Id do inquilino para o qual o token deve ser fornecido
  • Scopes - os scopes para os quais o token deve ser fornecido
  • Reivindicações - quaisquer reivindicações extra que o token tenha de satisfazer
AppTokenProviderResult

Objeto de saída para extensibilidade IAppTokenProvider.

  • accessToken - o token de acesso propriamente dito, tipicamente em formato JWT, que satisfaz os dados de pedido AppTokenProviderParameters
  • expiresInSeconds - quanto tempo o token tem antes de expirar, em segundos. Semelhante ao campo "expires_in" numa resposta de token AAD.
  • refreshInSeconds - o tempo que o token tem antes de ser atualizado proativamente. Semelhante ao campo "refresh_in" numa resposta de token AAD.
ClientAssertion

Credencial de Declaração de Cliente para Clientes Confidenciais

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

PedidoCredencial ComumCliente

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • autoridade - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir os tokens.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • skipCache - Ignorar a pesquisa de cache de tokens e forçar o pedido à autoridade para obter um novo token. É definido para false por padrão.
  • preferredAzureRegionOptions - Opções da região azure preferida do utilizador
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
CommonDeviceCodeRequest

Parâmetros para o fluxo de código do dispositivo Oauth2.

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • autoridade: - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir tokens. Se a authority for definida no objeto da aplicação cliente, esta irá sobrepor esse valor. Sobrepor o valor fará com que a validação da autoridade aconteça cada vez. Se a mesma autoridade for usada para todos os pedidos, defina o objeto de aplicação em vez dos pedidos.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • deviceCodeCallback - Chamada de retorno contendo resposta ao código do dispositivo. A mensagem deve ser mostrada ao utilizador final. O utilizador final pode então navegar até à verification_uri, introduzir a user_code e introduzir credenciais.
  • cancel - Booleano para cancelar o sondamento do endpoint do código do dispositivo. Enquanto o utilizador autentica num dispositivo separado, o MSAL consulta o endpoint do token do serviço de token de segurança para o intervalo especificado na resposta ao código do dispositivo (normalmente 15 minutos). Para parar de fazer polling e cancelar o pedido, defina cancel=true.
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
  • timeout - Período de timeout em segundos que o utilizador configura explicitamente para a sondagem do endpoint do código do dispositivo. No final deste período; assumindo que o código do dispositivo ainda não expirou; A sondagem do código do dispositivo é interrompida e o pedido cancelado. A janela de expiração do código do dispositivo terá sempre prioridade sobre este período definido.
  • extraQueryParameters - Mapa de string para string de parâmetros personalizados de consulta adicionados à cadeia de query
CommonOnBehalfOfRequest
  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • autoridade - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir os tokens.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • oboAssertion - O token de acesso que foi enviado para a API de nível intermédio. Este token deve ter uma audiência da aplicação que faz este pedido OBO.
  • skipCache - Ignorar a pesquisa de cache de tokens e forçar o pedido à autoridade para obter um novo token. É definido para false por padrão.
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
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.

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • claims - Um pedido de claims stringified que será adicionado a todas as chamadas /authorize e /token. Quando incluído num pedido silencioso, a pesquisa de cache será ignorada e o token será atualizado.
  • autoridade - URL da autoridade da qual a aplicação adquire os tokens.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • Nome de utilizador - Nome de utilizador do cliente
  • Palavra-passe - credenciais
  • tokenQueryParameters - Mapa de string para string de parâmetros de consulta personalizados adicionados à chamada /token
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.

  • userCode: código que o utilizador precisa de fornecer ao autenticar no URI de verificação
  • deviceCode: código que deve ser incluído no pedido do token de acesso
  • verificationUri: URI onde o utilizador pode autenticar-se
  • expiresIn: tempo de expiração do código do dispositivo em segundos
  • intervalo: intervalo em que o STS deve ser sondado em
  • Mensagem: Mensagem que deve ser apresentada ao utilizador
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

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

Função para construir um objeto info cliente a partir da string serverClientInfo

buildClientInfoFromHomeAccountId(string)

Função para construir um objeto de informação cliente a partir da cadeia homeAccountId em cache

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

Perfil do inquilino da construção

createAuthError(string, string)
createCacheError(unknown)

Função auxiliar para envolver erros do navegador num objeto CacheError

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

Cria um InteractionRequiredAuthError

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

Cria o objeto NetworkError para um pedido de rede falhado

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

Obtém o tenantId do token ID disponível reivindica ser definido como reino de credencial com a seguinte precedência:

  1. tid - se o token for adquirido de um tenant do Azure AD, o tid estará presente
  2. tfp - se o token for adquirido de um inquilino B2C moderno, o tfp deve estar presente
  3. 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
tenantIdMatchesHomeTenant(string, string)

Retorna verdadeiro se o tenantId corresponder à parte utid do homeAccountId

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

Variáveis

AADAuthorityConstants

Constantes de cadeia relacionadas com a Autoridade AAD

AuthenticationScheme

Tipo do pedido de autenticação

AuthorityType

Tipos de autoridade suportados pelo MSAL.

AzureCloudInstance
CacheAccountType

Tipos de conta na Cache

CacheOutcome

Especifica a razão para obter o token de acesso junto do fornecedor de identidade

CacheType

Combinar todos os tipos de cache

CcsCredentialType
ClaimsRequestKeys

Chaves de pedido de sinistros

CredentialType

Tipo de Credencial armazenado na cache

EncodingTypes
GrantType

permitido grant_type

HeaderNames

Nomes dos cabeçalhos do pedido

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

Valores permitidos para response_type

PasswordGrantConstants

Parâmetros de concessão de palavra-passe

PersistentCacheKeys

Chaves persistentes de cache MSAL que permanecem enquanto o utilizador está logado.

ProtocolMode

Modos de protocolo suportados pelo MSAL.

ResponseMode

valores permitidos para response_mode

ServerResponseType

Valores permitidos para o tipo de resposta do servidor

AuthErrorMessage

AuthErrorMessage classe contendo constantes de cadeia usadas por códigos de erro e mensagens.

ClientAuthErrorMessage

Constantes de cadeia usadas por códigos de erro e mensagens.

ClientConfigurationErrorMessage

A classe ClientConfigurationErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens.

CodeChallengeMethodValues

valores permitidos para codeVerifier

Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage

Interação requeria erros definidos pelo SDK

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
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"

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

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:

  1. tid - se o token for adquirido de um tenant do Azure AD, o tid estará presente
  2. tfp - se o token for adquirido de um inquilino B2C moderno, o tfp deve estar presente
  3. 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_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

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

StubbedNetworkModule: INetworkModule

Tipo

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"