@azure/msal-common package

Classes

AuthError

Classe de erro geral gerada pela biblioteca de MSAL.js.

AuthenticationHeaderParser

Essa é uma classe auxiliar que analisa cabeçalhos de autenticação de resposta HTTP com suporte para extrair e retornar valores de desafio de cabeçalho que podem ser usados fora dos fluxos básicos de autorização.

CacheError

Erro gerado quando há um erro com o cache

ClientAuthError

Erro gerado quando há um erro no código do cliente em execução no navegador.

ClientConfigurationError

Erro gerado quando há um erro na configuração da biblioteca de MSAL.js.

InteractionRequiredAuthError

Erro gerado quando a interação do usuário é necessária.

Logger

Classe que facilita o registro em log de mensagens em um local específico.

NetworkError

Representa erros relacionados à rede

PerformanceClient
PlatformBrokerError

Classe de erro para erros do MSAL Runtime que preserva informações detalhadas do agente

ProtocolUtils

Classe que fornece auxiliares para valores específicos do protocolo OAuth 2.0

ScopeSet

A classe ScopeSet cria um conjunto de escopos. Escopos não diferenciam maiúsculas de minúsculas, valores exclusivos, portanto, o objeto Set no JS faz mais sentido implementar para essa classe. Todos os escopos são cortados e convertidos em cadeias de caracteres minúsculas em funções de interseção e união para garantir a exclusividade das cadeias de caracteres.

ServerError

Erro gerado quando há um erro com o código do servidor, por exemplo, indisponibilidade.

StubPerformanceClient
UrlString

Classe de objeto url que pode executar várias transformações em cadeias de caracteres de URL.

TokenCacheContext

Essa instância de classe ajuda a controlar as alterações de memória facilitando as decisões de leitura e gravação no cache persistente

Interfaces

ICrypto

Interface para funções de criptografia usadas pela biblioteca

ILoggerCallback
INetworkModule

Interface de rede do cliente para enviar solicitações de back-end.

IPerformanceClient
IPerformanceMeasurement
IUri

Interface que descreve componentes de URI.

PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Aliases de tipo

AccessTokenEntity

Tipo de cache de token de acesso

AccountFilter

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

AccountInfo

Objeto account com a seguinte assinatura:

  • homeAccountId – Identificador de conta inicial para este objeto de conta
  • ambiente – Entidade que emitiu o token representado pelo domínio do emissor (por exemplo, login.microsoftonline.com)
  • tenantId – ID de locatário completo ou organizacional à qual essa conta pertence
  • nome de usuário - preferred_username declaração do id_token que representa essa conta
  • localAccountId – Identifer de conta local específica do locatário para esse objeto de conta, geralmente usado em casos herdados
  • nome – Nome completo da conta, incluindo nome e nome da família fornecidos
  • idToken – token de ID bruto
  • idTokenClaims – Objeto contém declarações do token de ID
  • nativeAccountId – ID da conta nativa do usuário
  • tenantProfiles - Mapa de objetos de perfil de locatário para cada locatário com o qual a conta foi autenticada no navegador
  • dataBoundary – Limite de dados extraído de clientInfo
ActiveAccountFilters
AppMetadataEntity

Tipo de cache de metadados do aplicativo

ApplicationTelemetry

Informações de telemetria enviadas sob solicitação

  • appName: nome de cadeia de caracteres exclusivo de um aplicativo
  • appVersion: versão do aplicativo usando MSAL
AuthenticationResult

Resultado retornado do ponto de extremidade de token da autoridade.

  • uniqueId - oid ou sub declaração do token de ID
  • tenantId - tid declaração do token de ID
  • escopos – Escopos validados para o respectivo token
  • conta – Uma representação de objeto de conta do usuário conectado no momento
  • idToken – Token de ID recebido como parte da resposta
  • idTokenClaims – declarações de token de ID relevantes para MSAL
  • accessToken - Token de acesso ou certificado SSH recebido como parte da resposta
  • fromCache – Boolean indicando se o token veio do cache
  • expiresOn – objeto Data javascript que representa 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 interrupção do servidor
  • refreshOn – Objeto Data javascript que representa a hora relativa até que um token de acesso seja atualizado
  • estado – Valor passado pelo usuário na solicitação
  • familyId – Identificador de ID da família, geralmente usado apenas para tokens de atualização
  • requestId – ID da solicitação retornada como parte da resposta
AuthorityOptions
AuthorizationCodePayload

Resposta retornada após o processamento da cadeia de caracteres ou fragmento da consulta de resposta de código.

AuthorizeResponse

Propriedades de resposta que podem ser retornadas pelo ponto de extremidade /authorize

AzureCloudOptions

Opções específicas do AzureCloudInstance

  • azureCloudInstance – enumeração de cadeia de caracteres que fornece notação curta para autoridades de nuvem pública e soverign
  • locatário – provisionar para fornecer as informações do locatário
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens. Usa https://login.microsoftonline.com/common como padrão. Se estiver usando a mesma autoridade para todas as solicitações, a autoridade deverá ser definida no objeto do aplicativo cliente e não na solicitação, para evitar a resolução de pontos de extremidade de autoridade várias vezes.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • authenticationScheme - O tipo de token recuperado. O padrão é "Portador". Também pode ser o tipo "pop" ou "SSH".
  • declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
  • shrClaims - Um objeto de declarações em cadeia de caracteres que será adicionado a uma solicitação HTTP assinada
  • shrNonce - Um carimbo de data/hora gerado pelo servidor que foi criptografado e codificado em base64URL, que será adicionado a uma solicitação HTTP assinada.
  • shrOptions - Um objeto que contém opções para a solicitação HTTP assinada
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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 Chave Web JSON em cadeia de caracteres que representa uma chave pública que pode ser assinada por um certificado SSH.
  • sshKid – ID de chave que identifica exclusivamente a chave pública SSH mencionada acima.
  • azureCloudOptions – Enumerações de cadeia de caracteres de conveniência para os usuários fornecerem IDs de nuvem pública/soberana
  • requestedClaimsHash – cadeia de caracteres de hash SHA 256 da cadeia de caracteres de declarações solicitada, usada como parte de uma chave de cache de token de acesso para que os tokens possam ser filtrados por declarações solicitadas
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
  • tokenBodyParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros personalizados adicionados ao corpo da chamada /token
  • storeInCache - Objeto que contém valores boolianos que indicam se os tokens devem ser armazenados no cache ou não (o padrão é verdadeiro)
  • scenarioId – ID do cenário para rastrear prompts de usuário personalizados
  • popKid – ID da chave para identificar a chave pública para solicitação de token PoP
  • embeddedClientId – ID do cliente inserido. Quando especificado, os parâmetros de ID do cliente do agente (brk_client_id) e uri de redirecionamento (brk_redirect_uri) são definidos com valores da configuração, substituindo os parâmetros extras correspondentes, se presentes.
  • httpMethod – método HTTP a ser usado para a solicitação /authorize. O padrão é GET, mas pode ser definido como POST se a solicitação exigir parâmetros de corpo
  • authorizePostBodyParameters - String to string map of custom parameters added to the body of the /authorize call when httpMethod is set to POST
  • skipBrokerClaims - Quando true e um fluxo agenciado são usados (por exemplo, quando parâmetros de agente ou um embeddedClientId estão presentes), clientCapabilities da configuração será excluído das declarações; ignorado para fluxos não intermediados.
CacheOptions

Use isso para configurar as preferências de cache de credencial no objeto ClientConfiguration

  • claimsBasedCachingEnabled – define se os tokens devem ser armazenados em cache com base no hash de declarações. O padrão é false.
CcsCredential
ClientInfo

Objeto de informações do cliente que consiste em: uid: id de usuário utid: id de locatário xms_tdbr: opcional, somente para locatários que não são dos EUA

CommonAuthorizationCodeRequest

Solicitar objeto passado pelo usuário para adquirir um token do servidor trocando um código de autorização válido (segunda etapa do fluxo de código de autorização OAuth2.0)

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
  • autoridade: - URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens. Se a autoridade for definida no objeto de aplicativo cliente, isso substituirá esse valor. Substituir o valor fará com que a validação da autoridade ocorra sempre. Se a mesma autoridade for usada para todas as solicitações, defina no objeto do aplicativo em vez das solicitações.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • redirectUri – O URI de redirecionamento do seu aplicativo, para o qual a autoridade será redirecionada após o usuário inserir credenciais e consentimentos. Ele deve corresponder exatamente a uma das URIs de redirecionamento que você registrou no portal
  • código - O authorization_code que o usuário adquiriu na primeira etapa do fluxo.
  • codeVerifier - O mesmo code_verifier que foi usado para obter o authorization_code. Necessário se o PKCE foi usado na solicitação de concessão de código de autorização. Para obter mais informações, consulte o RFC do PKCE: https://tools.ietf.org/html/rfc7636
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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 – Habilita a acqusição de um código de autorização de spa (somente clientes confidenciais)
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
CommonAuthorizationUrlRequest

Solicitar objeto passado pelo usuário para recuperar um código do servidor (primeira etapa do fluxo de concessão de código de autorização)

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
  • autoridade – URL da autoridade da qual o aplicativo adquire tokens.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • redirectUri – O URI de redirecionamento em que as respostas de autenticação podem ser recebidas pelo aplicativo. Ele deve corresponder exatamente a um dos URIs de redirecionamento registrados no portal Azure.
  • extraScopesToConsent – Escopos para um recurso diferente quando o usuário precisa de consentimento antecipadamente.
  • responseMode – Especifica o método que deve ser usado para enviar o resultado da autenticação para seu aplicativo. Pode ser consulta, form_post ou fragmento. Se nenhum valor for passado, ele usará como padrão a consulta.
  • codeChallenge – usado para proteger a concessão de código de autorização por meio da Prova de Chave para O Código Exchange (PKCE). Para obter 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, supõe-se que o desafio de código seja texto sem formatação. Para obter mais informações, consulte o PKCE RCF: https://tools.ietf.org/html/rfc7636
  • estado – um valor incluído na solicitação que também é retornado na resposta do token. Um valor exclusivo gerado aleatoriamente normalmente é usado para evitar ataques de falsificação de solicitação entre sites. O estado também é usado para codificar informações sobre o estado do usuário no aplicativo antes da solicitação de autenticação ocorrer.
  • prompt – Indica o tipo de interação do usuário que é necessário. logon: forçará o usuário a inserir suas credenciais nessa solicitação, negando o logon único: garantirá que o usuário não seja apresentado a nenhum prompt interativo. se a solicitação não puder ser concluída por meio do logon único, o ponto de extremidade retornará um consentimento de erro interaction_required: disparará a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando ao usuário que conceda permissões ao aplicativo select_account: interromperá o logon único, fornecendo a experiência de seleção da conta listando todas as contas na sessão ou quaisquer contas lembradas ou uma opção para optar por usar uma conta diferente, crie: direcionará o usuário para a experiência de criação da conta em vez da experiência de logon no_session: não lerá o token de sessão existente ao autenticar o usuário. Após o usuário ser autenticado com êxito, o EVO não criará uma nova sessão para o usuário. APENAS PARA UTILIZAÇÃO INTERNA.
  • conta – AccountInfo obtido de uma API getAccount. Será usado em determinados cenários para gerar login_hint se os parâmetros loginHint e sid não forem fornecidos.
  • loginHint - Pode ser usado para preencher previamente o campo nome de usuário/endereço de email da página de entrada do usuário, se você souber o nome de usuário/endereço de email com antecedência. Geralmente, os aplicativos usam esse parâmetro durante a autenticação nova, já tendo extraído o nome de usuário de uma entrada anterior usando a declaração preferred_username.
  • sid – ID da sessão, identificador exclusivo para a sessão. Disponível como uma declaração opcional em tokens de ID.
  • domainHint – Fornece uma dica sobre o locatário ou domínio que o usuário deve usar para entrar. O valor da dica de domínio é um domínio registrado para o locatário.
  • extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /authorize
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
  • nonce - Um valor incluído na solicitação que é retornada no token de id. Um valor exclusivo gerado aleatoriamente normalmente é usado para atenuar ataques de reprodução.
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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

CommonEndSessionRequest

  • conta – objeto de conta do qual será feito logon. Todos os tokens vinculados a essa conta serão limpos.
  • postLogoutRedirectUri – URI para navegar até a página após o logoff.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • idTokenHint – Token de ID usado por B2C para validar o logoff, se necessário, pela política
  • estado - Um valor incluído na solicitação para o ponto de extremidade de logoff que será retornado na cadeia de caracteres de consulta após o redirecionamento de logoff
  • logoutHint – Uma cadeia de caracteres que especifica a conta que está sendo registrada em log para ignorar o seletor de conta do servidor no logoff
  • extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /authorize
CommonRefreshTokenRequest

CommonRefreshTokenRequest

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
  • autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • refreshToken – um token de atualização retornado de uma solicitação anterior para o provedor de identidade.
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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 – Force a MSAL a armazenar em cache uma resposta de fluxo de token de atualização quando não houver nenhuma conta no cache. Usado para cenários de migração.
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
CommonSilentFlowRequest

Parâmetros do SilentFlow passados pelo usuário para recuperar credenciais silenciosamente

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token. Quando incluído em uma solicitação silenciosa, a pesquisa de cache será ignorada e o token será atualizado.
  • autoridade – URL da autoridade da qual o aplicativo adquire tokens.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • conta – Entidade de conta para pesquisar as credenciais.
  • forceRefresh – Força solicitações silenciosas para fazer chamadas de rede se verdadeiras.
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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 – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
CredentialEntity

Tipo de cache de credencial

CredentialFilter

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

ExternalTokenResponse

Objeto de resposta usado para carregar tokens externos em cache.

  • token_type: indica o valor do tipo de token. O único tipo que Azure AD dá suporte é o Portador.
  • escopo: os escopos para os quais o access_token é válido.
  • expires_in: quanto tempo o token de acesso é válido (em segundos).
  • id_token: Um JWT (Token Web JSON). O aplicativo pode decodificar os segmentos desse token para solicitar informações sobre o usuário que se conectou.
  • refresh_token: um token de atualização do OAuth 2.0. O aplicativo pode usar esse token para adquirir tokens de acesso adicionais depois que o token de acesso atual expirar.
  • access_token: o token de acesso solicitado. O aplicativo pode usar esse token para se autenticar no recurso protegido, como uma API Web.
  • client_info: objeto de informações do cliente
IdTokenEntity

Tipo de Cache de Token de ID

InProgressPerformanceEvent
LibraryStateObject

Tipo que define o objeto que é stringified, codificado e enviado no valor de estado. Contém o seguinte:

  • id – identificador exclusivo para esta solicitação
  • ts - carimbo de data/hora para o momento em que a solicitação foi feita. Usado para garantir que a expiração do token não seja calculada incorretamente.
  • platformState – valor da cadeia de caracteres enviado da plataforma.
LoggerOptions

Use isso para configurar o log que a MSAL faz, configurando as opções do agente no objeto Configuração

  • loggerCallback – Retorno de chamada para agente
  • piiLoggingEnabled – define se o registro em log pii está habilitado
  • logLevel – Define o nível no qual o registro em log ocorre
  • correlationId – Define a correlationId impressa pelo agente
NetworkRequestOptions

Opções permitidas por APIs de solicitação de rede.

NetworkResponse
OIDCOptions

Opções para o modo de protocolo OIDC.

PerformanceCallbackFunction
PerformanceEvent

Medida de desempenho feita pela biblioteca, incluindo metadados sobre a solicitação e o aplicativo.

PkceCodes

O tipo PkceCodes descreve a estrutura de objetos que contêm desafio de código PKCE e pares verificador

QueueMeasurement

Tipo de medida de fila

RefreshTokenEntity

Atualizar tipo de cache de token

RequestStateObject

Tipo que define o objeto codificado e em cadeia de caracteres enviado ao serviço na solicitação de autorização.

RequestThumbprint

Tipo que representa uma impressão digital de solicitação exclusiva.

ServerAuthorizationTokenResponse

Objeto de resposta desserializado da solicitação de código de autorização do servidor.

  • token_type: indica o valor do tipo de token. Pode ser portador ou pop.
  • escopo: os escopos para os quais o access_token é válido.
  • expires_in: quanto tempo o token de acesso é válido (em segundos).
  • refresh_in: duração aferir qual token deve ser renovado, independentemente da expiração.
  • ext_expires_in: por quanto tempo o token de acesso é válido (em segundos) se o servidor não estiver respondendo.
  • access_token: o token de acesso solicitado. O aplicativo pode usar esse token para se autenticar no recurso protegido, como uma API Web.
  • refresh_token: um token de atualização do OAuth 2.0. O aplicativo pode usar esse token para adquirir tokens de acesso adicionais depois que o token de acesso atual expirar.
  • id_token: Um JWT (Token Web JSON). O aplicativo pode decodificar os segmentos desse token para solicitar informações sobre o usuário que se conectou.
  • key_id: uma cadeia de caracteres que identifica exclusivamente uma chave pública à qual a solicitação está associada.

Em caso de erro:

  • erro: uma cadeia de caracteres 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 desenvolvedor a identificar a causa raiz de um erro de autenticação.
  • error_codes: uma lista de códigos de erro específicos do STS que podem ajudar no diagnóstico.
  • carimbo de data/hora: a hora em que o erro ocorreu.
  • trace_id: um identificador exclusivo para a solicitação que pode ajudar no diagnóstico.
  • correlation_id: um identificador exclusivo para a solicitação que pode ajudar no diagnóstico entre componentes.
  • status: o status de resposta da solicitação de rede
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache

Controla se os tokens devem ser armazenados no cache ou não. Se definido como false, os tokens ainda poderão ser adquiridos e retornados, mas não serão armazenados em cache para recuperação posterior.

StringDict

Key-Value tipo para dar suporte a queryParams, extraQueryParams e declarações

SubMeasurement
SystemOptions

Use isso para configurar informações de renovação de token no objeto Configuration

  • tokenRenewalOffsetSeconds - Define a janela de deslocamento necessária para renovar o token antes da expiração
TenantProfile

Detalhes da conta que variam entre locatários para o mesmo usuário

ThrottlingEntity
TokenClaims

Tipo que descreve declarações de Token de Id conhecidas pela MSAL.

TokenKeys
AppTokenProviderParameters

Objeto de entrada para a extensibilidade IAppTokenProvider. A MSAL criará esse objeto, que pode ser usado para ajudar a criar um AppTokenProviderResult.

  • correlationId - a ID de correlação associada à solicitação
  • tenantId - a ID do locatário para a qual o token deve ser fornecido
  • escopos – os escopos para os quais o token deve ser fornecido
  • declarações - quaisquer declarações extras que o token deve satisfazer
AppTokenProviderResult

Objeto de saída para extensibilidade IAppTokenProvider.

  • accessToken - o token de acesso real, normalmente no formato JWT, que satisfaz os dados de solicitação AppTokenProviderParameters
  • expiresInSeconds - quanto tempo os tokens têm antes da expiração, em segundos. Semelhante ao campo "expires_in" em uma resposta de token do AAD.
  • refreshInSeconds - quanto tempo o token tem antes de ser atualizado proativamente. Semelhante ao campo "refresh_in" em uma resposta de token do AAD.
ClientAssertion

Credencial de declaração de cliente para clientes confidenciais

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • skipCache – Ignorar a pesquisa de cache de token e forçar a solicitação à autoridade para obter um novo token. O padrão é false.
  • preferredAzureRegionOptions – Opções da região preferencial do azure do usuário
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
CommonDeviceCodeRequest

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

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • autoridade: - URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens. Se a autoridade for definida no objeto de aplicativo cliente, isso substituirá esse valor. Substituir o valor fará com que a validação da autoridade ocorra sempre. Se a mesma autoridade for usada para todas as solicitações, defina no objeto do aplicativo em vez das solicitações.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • deviceCodeCallback – Retorno de chamada que contém a resposta do código do dispositivo. A mensagem deve ser mostrada ao usuário final. Em seguida, o usuário final pode navegar até o verification_uri, inserir o user_code e as credenciais de entrada.
  • cancelar – booliano para cancelar a sondagem do ponto de extremidade de código do dispositivo. Enquanto o usuário se autentica em um dispositivo separado, a MSAL sonda o ponto de extremidade de token do serviço de token de segurança para o intervalo especificado na resposta de código do dispositivo (geralmente 15 minutos). Para interromper a sondagem e cancelar a solicitação, defina cancel=true.
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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.
  • tempo limite – período de tempo limite em segundos que o usuário configura explicitamente para a sondagem do ponto de extremidade de código do dispositivo. No final desse período; supondo que o código do dispositivo ainda não expirou; a sondagem de código do dispositivo é interrompida e a solicitação cancelada. A janela de expiração do código do dispositivo sempre terá precedência durante esse período de conjunto.
  • extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à cadeia de caracteres de consulta
CommonOnBehalfOfRequest
  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • oboAssertion – O token de acesso que foi enviado para a API de camada intermediária. Esse token deve ter um público-alvo do aplicativo que está fazendo essa solicitação OBO.
  • skipCache – Ignorar a pesquisa de cache de token e forçar a solicitação à autoridade para obter um novo token. O padrão é false.
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
CommonUsernamePasswordRequest

Parâmetros CommonUsernamePassword passados pelo usuário para recuperar credenciais Observação: a prática atual de segurança mais recente do OAuth 2.0 não permite totalmente a concessão de senha. Esse fluxo é adicionado para testes internos.

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token. Quando incluído em uma solicitação silenciosa, a pesquisa de cache será ignorada e o token será atualizado.
  • autoridade – URL da autoridade da qual o aplicativo adquire tokens.
  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • nome de usuário – nome de usuário do cliente
  • senha - credenciais
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
DeviceCodeResponse

DeviceCode retornado pelo ponto de extremidade de código do dispositivo do serviço de token de segurança que contém informações necessárias para o fluxo de código do dispositivo.

  • userCode: código que o usuário precisa fornecer ao autenticar no URI de verificação
  • deviceCode: código que deve ser incluído na solicitação do token de acesso
  • verificationUri: URI em que o usuário pode autenticar
  • expiresIn: tempo de expiração do código do dispositivo em segundos
  • intervalo: intervalo no qual o STS deve ser sondado em
  • mensagem: mensagem que deve ser exibida para o usuário
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Enumerações

LogLevel

Nível de mensagem de log.

PerformanceEventStatus

Estado do evento de desempenho.

PerformanceEvents

A enumeração de operações instrumentadas tem 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 criar um objeto de informações do cliente a partir da cadeia de caracteres clientInfo do servidor

buildClientInfoFromHomeAccountId(string)

Função para criar um objeto de informações do cliente da cadeia de caracteres homeAccountId armazenada em cache

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

Criar perfil de locatário

createAuthError(string, string)
createCacheError(unknown)

Função auxiliar para encapsular erros do navegador em um objeto CacheError

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

Cria um InteractionRequiredAuthError

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

Cria o objeto NetworkError para uma solicitação de rede com falha

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

Obtém tenantId de declarações de token de ID disponíveis para definir como realm de credencial com a seguinte precedência:

  1. tid - se o token for adquirido de um Azure tid de locatário do AD estará presente
  2. tfp - se o token for adquirido de um tfp de locatário B2C moderno deverá estar presente
  3. acr - se o token for adquirido de um acr de locatário B2C herdado deverá estar presente downcased para corresponder aos requisitos de comparação que não diferenciam maiúsculas de minúsculas do realm
tenantIdMatchesHomeTenant(string, string)

Retorna true se tenantId corresponder à parte utid de homeAccountId

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Substitui as informações da conta que variam de acordo com o perfil de locatário originado das declarações de token de ID passadas pelas informações da conta específicas do locatário

Variáveis

AADAuthorityConstants

Constantes de cadeia de caracteres relacionadas à Autoridade do AAD

AuthenticationScheme

Tipo da solicitação de autenticação

AuthorityType

Tipos de autoridade com suporte da MSAL.

AzureCloudInstance
CacheAccountType

Tipos de conta no Cache

CacheOutcome

Especifica o motivo para buscar o token de acesso do provedor de identidade

CacheType

Combinar todos os tipos de cache

CcsCredentialType
ClaimsRequestKeys

Chaves de solicitação de declarações

CredentialType

Tipo de credencial armazenado no cache

EncodingTypes
GrantType

permitido grant_type

HeaderNames

Nomes de cabeçalho de solicitação

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

Valores permitidos para response_type

PasswordGrantConstants

Parâmetros de concessão de senha

PersistentCacheKeys

MSAL de chaves de cache persistentes que permanecem enquanto o usuário está conectado.

ProtocolMode

Modos de protocolo compatíveis com a MSAL.

ResponseMode

valores permitidos para response_mode

ServerResponseType

valores permitidos para o tipo de resposta do servidor

AuthErrorMessage

Classe AuthErrorMessage que contém constantes de cadeia de caracteres usadas por códigos de erro e mensagens.

ClientAuthErrorMessage

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

ClientConfigurationErrorMessage

Classe ClientConfigurationErrorMessage que contém constantes de cadeia de caracteres 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

Erros de interação necessários definidos pelo SDK

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue

consideramos fazer essa "enumeração" na solicitação em vez de cadeia de caracteres, no entanto, parece que a lista permitida de valores de prompt continuou mudando nos últimos dois anos. Há alguns valores de prompt não documentados para alguns parceiros internos também, daí a escolha do tipo genérico de "cadeia de caracteres" em vez de "enumerar"

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

Constantes relacionadas à limitação

version

Detalhes da 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

Retornos

AccountEntity

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

Função para criar um objeto de informações do cliente a partir da cadeia de caracteres clientInfo do servidor

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

Parâmetros

rawClientInfo

string

base64Decode

(input: string) => string

Retornos

buildClientInfoFromHomeAccountId(string)

Função para criar um objeto de informações do cliente da cadeia de caracteres homeAccountId armazenada em cache

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parâmetros

homeAccountId

string

Retornos

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

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

Parâmetros

authOptions

Partial<AuthorityOptions>

Retornos

buildTenantProfile(string, string, string, TokenClaims)

Criar perfil de locatário

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

Identifer de conta local para este objeto de conta

tenantId

string

ID de locatário ou organizacional completa à qual essa conta pertence

idTokenClaims
TokenClaims

Declarações do token de ID

Retornos

createAuthError(string, string)

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

Parâmetros

code

string

additionalMessage

string

Retornos

createCacheError(unknown)

Função auxiliar para encapsular erros do navegador em um objeto CacheError

function createCacheError(e: unknown): CacheError

Parâmetros

e

unknown

Retornos

createClientAuthError(string, string)

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

Parâmetros

errorCode

string

additionalMessage

string

Retornos

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parâmetros

errorCode

string

Retornos

createInteractionRequiredAuthError(string)

Cria um InteractionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parâmetros

errorCode

string

Retornos

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

Cria o objeto NetworkError para uma solicitação de rede com falha

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

Parâmetros

error
AuthError

Erro ao ser jogado de volta para o chamador

httpStatus

number

Código de status da solicitação de rede

responseHeaders

Record<string, string>

Cabeçalhos de resposta da solicitação de rede, quando disponível

additionalError

Error

Retornos

Objeto NetworkError

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parâmetros

authorityUri

string

Retornos

string

getRequestThumbprint(string, BaseAuthRequest, string)

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

Parâmetros

clientId

string

request
BaseAuthRequest
homeAccountId

string

Retornos

getTenantIdFromIdTokenClaims(TokenClaims)

Obtém tenantId de declarações de token de ID disponíveis para definir como realm de credencial com a seguinte precedência:

  1. tid - se o token for adquirido de um Azure tid de locatário do AD estará presente
  2. tfp - se o token for adquirido de um tfp de locatário B2C moderno deverá estar presente
  3. acr - se o token for adquirido de um acr de locatário B2C herdado deverá estar presente downcased para corresponder aos requisitos de comparação que não diferenciam maiúsculas de minúsculas do realm
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Parâmetros

idTokenClaims
TokenClaims

Retornos

string | null

tenantIdMatchesHomeTenant(string, string)

Retorna true se tenantId corresponder à parte utid de homeAccountId

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

Parâmetros

tenantId

string

homeAccountId

string

Retornos

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Substitui as informações da conta que variam de acordo com o perfil de locatário originado das declarações de token de ID passadas pelas informações da conta específicas do locatário

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

Parâmetros

baseAccountInfo
AccountInfo
tenantProfile
TenantProfile
idTokenClaims
TokenClaims
idTokenSecret

string

Retornos

Detalhes da variável

AADAuthorityConstants

Constantes de cadeia de caracteres relacionadas à Autoridade do AAD

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

Tipo

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

AuthenticationScheme

Tipo da solicitação de autenticação

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

Tipo

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

AuthorityType

Tipos de autoridade com suporte da 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 no 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 o motivo para buscar o token de acesso do provedor 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 solicitação de declarações

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

Tipo

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

CredentialType

Tipo de credencial armazenado no 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 de cabeçalho de solicitação

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 senha

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

Tipo

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

PersistentCacheKeys

MSAL de chaves de cache persistentes que permanecem enquanto o usuário está conectado.

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

Tipo

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Modos de protocolo compatíveis com a 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

Essa 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

Essa API foi preterida.

Use AuthErrorCodes instead

Classe AuthErrorMessage que contém constantes de cadeia de caracteres 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

Essa API foi preterida.

Use ClientAuthErrorCodes instead

Constantes de cadeia de caracteres 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

Essa API foi preterida.

Use ClientConfigurationErrorCodes instead

Classe ClientConfigurationErrorMessage que contém constantes de cadeia de caracteres 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

Essa API foi preterida.

Use InteractionRequiredAuthErrorCodes instead

Erros de interação necessários 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

consideramos fazer essa "enumeração" na solicitação em vez de cadeia de caracteres, no entanto, parece que a lista permitida de valores de prompt continuou mudando nos últimos dois anos. Há alguns valores de prompt não documentados para alguns parceiros internos também, daí a escolha do tipo genérico de "cadeia de caracteres" em vez de "enumerar"

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 à 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"