@azure/msal-browser 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.

BrowserAuthError

Classe de erro da biblioteca do navegador gerada pela biblioteca de MSAL.js para SPAs

BrowserConfigurationAuthError

Classe de erro da biblioteca do navegador gerada pela biblioteca de MSAL.js para SPAs

BrowserPerformanceClient
BrowserPerformanceMeasurement
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.

EventHandler
EventMessageUtils
InteractionRequiredAuthError

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

LocalStorage
Logger

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

MemoryStorage
NavigationClient
PublicClientApplication

A classe PublicClientApplication é o objeto exposto pela biblioteca para executar funções de autenticação e autorização em Aplicativos de Página Única para obter tokens JWT, conforme descrito no Fluxo de Código de Autorização do OAuth 2.0 com especificação PKCE.

PublicClientNext

PublicClientNext é uma olhada antecipada na implementação planejada de PublicClientApplication na próxima versão principal do MSAL.js. Ele contém suporte para várias implementações de API com base no ambiente de runtime em que está em execução.

Os objetivos dessas alterações são fornecer uma separação limpa do comportamento entre diferentes contextos operacionais (Autenticação de Aplicativo Aninhada, Agentes de Plataforma, Navegador Antigo Simples etc.) enquanto ainda fornece uma superfície de API consistente para desenvolvedores.

Use PublicClientApplication para qualquer cenário prod/real. Observação: PublicClientNext é experimental e está sujeito a alterações interruptivas sem o seguinte semver

ServerError

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

SessionStorage
SignedHttpRequest
StubPerformanceClient
UrlString

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

AuthFlowActionRequiredStateBase

Classe base para o estado de requrição da ação em um fluxo de autenticação.

AuthFlowStateBase

Classe base para o estado de um fluxo de autenticação.

AuthMethodRegistrationChallengeMethodError

Erro que ocorreu durante a solicitação de desafio do método de autenticação.

AuthMethodRegistrationChallengeMethodResult

Resultado do desafio de um método de autenticação para registro. Usa o tipo de estado base para evitar dependências circulares.

AuthMethodRegistrationCompletedState

Estado que indica que o fluxo de registro do método de autenticação foi concluído com êxito.

AuthMethodRegistrationFailedState

Estado que indica que o fluxo de registro do método de autenticação falhou.

AuthMethodRegistrationRequiredState

Estado que indica que o registro do método de autenticação é necessário.

AuthMethodRegistrationSubmitChallengeError

Erro que ocorreu durante o envio do desafio do método de autenticação.

AuthMethodRegistrationSubmitChallengeResult

Resultado do envio de um desafio para o registro do método de autenticação.

AuthMethodVerificationRequiredState

Estado que indica que a verificação é necessária para o método de autenticação desafiado.

CustomAuthAccountData
CustomAuthApiError

Erro de API de Autenticação Personalizada.

CustomAuthError
CustomAuthPublicClientApplication
GetAccessTokenResult
GetAccountError

A classe de erro para obter erros de conta.

GetAccountResult
GetCurrentAccountAccessTokenError

A classe de erro para obter os erros de token de acesso da conta atual.

HttpError
InvalidArgumentError
InvalidConfigurationError
MethodNotImplementedError
MfaAwaitingState

Estado que indica que a MFA é necessária e aguarda a ação do usuário. Esse estado permite que o desenvolvedor pause a execução antes de enviar o código para o email do usuário.

MfaCompletedState

Estado que indica que o fluxo de MFA foi concluído com êxito.

MfaFailedState

Estado que indica que o fluxo de MFA falhou.

MfaRequestChallengeError

Erro que ocorreu durante a solicitação de desafio da MFA.

MfaRequestChallengeResult

Resultado da solicitação de um desafio de MFA. Usa o tipo de estado base para evitar dependências circulares.

MfaSubmitChallengeError

Erro que ocorreu durante o envio do desafio da MFA.

MfaSubmitChallengeResult

Resultado do envio de um desafio de MFA.

MfaVerificationRequiredState

Estado que indica que a verificação de MFA é necessária. O desafio foi enviado e o usuário precisa fornecer o código.

MsalCustomAuthError
NoCachedAccountFoundError
ParsedUrlError
ResetPasswordCodeRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

ResetPasswordCompletedState

Representa o estado que indica a conclusão bem-sucedida de uma operação de redefinição de senha.

ResetPasswordError
ResetPasswordFailedState

Estado de uma operação de redefinição de senha que falhou.

ResetPasswordPasswordRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

ResetPasswordResendCodeError
ResetPasswordResendCodeResult
ResetPasswordStartResult
ResetPasswordState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

ResetPasswordSubmitCodeError
ResetPasswordSubmitCodeResult
ResetPasswordSubmitPasswordError
ResetPasswordSubmitPasswordResult
SignInCodeRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignInCompletedState

Representa o estado concluído da operação de entrada. Esse estado indica que o processo de entrada foi concluído com êxito.

SignInContinuationState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignInError
SignInFailedState

Representa o estado de uma operação de entrada que falhou.

SignInPasswordRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignInResendCodeError
SignInResendCodeResult
SignInResult
SignInState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignInSubmitCodeError
SignInSubmitCodeResult
SignInSubmitPasswordError
SignInSubmitPasswordResult
SignOutError

A classe de erro para erros de saída.

SignOutResult
SignUpAttributesRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignUpCodeRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignUpCompletedState

Representa o estado de uma operação de inscrição que foi concluída com êxito.

SignUpError
SignUpFailedState

Representa o estado de uma operação de inscrição que falhou.

SignUpPasswordRequiredState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignUpResendCodeError
SignUpResendCodeResult
SignUpResult
SignUpState

Classe base para o estado de requrição da ação em um fluxo de autenticação.

SignUpSubmitAttributesError
SignUpSubmitAttributesResult
SignUpSubmitCodeError
SignUpSubmitCodeResult
SignUpSubmitPasswordError
SignUpSubmitPasswordResult
UnexpectedError
UnsupportedEnvironmentError
UserAccountAttributeError
UserAlreadySignedInError

Interfaces

IController
ILoggerCallback
INavigationClient
INetworkModule

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

IPerformanceClient
IPublicClientApplication
ITokenCache
IWindowStorage
AuthMethodDetails

Detalhes de um método de autenticação a ser registrado.

AuthenticationMethod
ICustomAuthPublicClientApplication

Aliases de tipo

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
AuthenticationResult
AuthorizationCodeRequest
AuthorizationUrlRequest

Esse tipo foi preterido e será removido na próxima atualização de versão principal

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
BrokerConnectionEvent

Conteúdo do evento BrokerConnectionEstablished

BrowserAuthOptions

Use isso para configurar as opções de autenticação no objeto Configuration

BrowserSystemOptions
BrowserTelemetryOptions

Opções de telemetria

CacheOptions

Use isso para configurar as opções de configuração de cache abaixo:

ClearCacheRequest

ClearCacheRequest

  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
  • conta – objeto de conta do qual será feito logon. Todos os tokens vinculados a essa conta serão limpos.
Configuration

Esse objeto permite configurar elementos importantes da funcionalidade MSAL e é passado para o construtor de PublicClientApplication

EndSessionPopupRequest

EndSessionPopupRequest

  • 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 dentro do pop-up. Necessário para garantir que o pop-up possa ser fechado.
  • autoridade – Autoridade para a qual enviar a solicitação de 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
  • mainWindowRedirectUri – URI para navegar pela janela principal após a conclusão do logoff
  • popupWindowAttributes – Atributos de janela pop-up opcionais. popupSize com altura e largura e popupPosition com parte superior e esquerda podem ser definidos.
  • 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
  • popupWindowParent – Objeto de janela opcional a ser usado como pai ao abrir janelas pop-up. Usa global window se não for dado.
EndSessionRequest

EndSessionRequest

  • 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.
  • autoridade – Autoridade para a qual enviar a solicitação de 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
  • onRedirectNavigate – Retorno de chamada que será passado para a URL para a qual a MSAL navegará. Retornar false no retorno de chamada interromperá a navegação.
  • 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
EventCallbackFunction
EventError
EventMessage
EventPayload
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
IdTokenClaims

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

InProgressPerformanceEvent
InitializeApplicationRequest

InitializeApplicationRequest: solicitar objeto passado pelo usuário para inicializar o aplicativo

  • correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
LoadTokenOptions
NavigationOptions

Informações adicionais passadas para as funções navigateInternal e navigateExternal

NetworkRequestOptions

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

NetworkResponse
PerformanceCallbackFunction
PerformanceEvent

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

PopupEvent
PopupPosition
PopupRequest

PopupRequest: 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) com uma janela pop-up.

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • 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.
  • 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.
  • 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 novamente, já tendo extraído o nome de usuário de uma entrada anterior usando a declaração login_hint ou 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
  • tokenBodyParameters – Cadeia de caracteres para o mapa de cadeia de caracteres dos parâmetros de corpo da solicitação de token personalizado adicionados à chamada /token. Usado somente ao renovar tokens de acesso.
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
  • declarações - Nos casos em que Azure administrador de locatários do AD habilitou políticas de acesso condicional e a política não foi atendida, as exceções conterão declarações que precisam ser consentidas.
  • 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.
  • popupWindowAttributes – Atributos de janela pop-up opcionais. popupSize com altura e largura e popupPosition com parte superior e esquerda podem ser definidos.
  • popupWindowParent – Objeto de janela opcional a ser usado como pai ao abrir janelas pop-up. Usa global window se não for dado.
PopupSize
PopupWindowAttributes

Configurações de pop-up para definir dimensões e posição da janela pop-up

RedirectRequest

RedirectRequest: 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) com um redirecionamento de página inteira.

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • 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.
  • 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.
  • 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 novamente, já tendo extraído o nome de usuário de uma entrada anterior usando a declaração login_hint ou 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
  • tokenBodyParameters – Cadeia de caracteres para o mapa de cadeia de caracteres dos parâmetros de corpo da solicitação de token personalizado adicionados à chamada /token. Usado somente ao renovar tokens de acesso.
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
  • declarações - Nos casos em que Azure administrador de locatários do AD habilitou políticas de acesso condicional e a política não foi atendida, as exceções conterão declarações que precisam ser consentidas.
  • 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.
  • redirectStartPage - A página para a qual deve ser retornado após loginRedirect ou acquireTokenRedirect. Isso só deve ser usado se isso for diferente do redirectUri e será o padrão para a página que inicia a solicitação. Quando a opção de configuração navigateToLoginRequestUrl for definida como false, esse parâmetro será ignorado.
  • onRedirectNavigate – Retorno de chamada que será passado para a URL para a qual a MSAL navegará. Retornar false no retorno de chamada interromperá a navegação.
SignedHttpRequestOptions
SilentRequest

SilentRequest: Solicitar objeto passado pelo usuário para recuperar tokens do cache, renovar um token expirado com um token de atualização ou recuperar um código (primeira etapa do fluxo de concessão de código de autorização) em um iframe oculto.

  • escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
  • 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.
  • extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /authorize. Usado somente ao renovar o token de atualização.
  • tokenBodyParameters – Cadeia de caracteres para o mapa de cadeia de caracteres dos parâmetros de corpo da solicitação de token personalizado adicionados à chamada /token. Usado somente ao renovar tokens de acesso.
  • tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token. Usado somente ao renovar tokens de acesso.
  • 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. Usado somente para casos em que o token de atualização expirou.
  • cacheLookupPolicy – Enumeração de diferentes maneiras pelas quais o token silencioso pode ser recuperado.
  • prompt – Indica o tipo de interação do usuário que é necessário. nenhum: 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 erro interaction_required 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.
SsoSilentRequest

Solicitar objeto passado pelo usuário para ssoSilent 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 quais o aplicativo está solicitando acesso (opcional para chamadas ssoSilent)
  • 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.
  • 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á uma interaction_required consentimento de erro: disparará a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando que o usuário 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.
  • 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 novamente, já tendo extraído o nome de usuário de uma entrada anterior usando a declaração login_hint ou 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
  • tokenBodyParameters – Cadeia de caracteres para o mapa de cadeia de caracteres dos parâmetros de corpo da solicitação de token personalizado adicionados à chamada /token. Usado somente ao renovar tokens de acesso.
  • 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.
TenantProfile

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

AccessTokenRetrievalInputs
AccountRetrievalInputs
AuthMethodRegistrationChallengeMethodResultState

Definição de tipo para estados possíveis em AuthMethodRegistrationChallengeMethodResult.

AuthMethodRegistrationSubmitChallengeResultState

Definição de tipo para estados possíveis em AuthMethodRegistrationSubmitChallengeResult.

CustomAuthConfiguration
GetAccessTokenResultState

Os estados possíveis para o GetAccessTokenResult. Isso inclui:

  • GetAccessTokenCompletedState: o token de acesso foi recuperado com êxito.
  • GetAccessTokenFailedState: falha na recuperação do token de acesso.
GetAccountResultState

Os estados possíveis para o GetAccountResult. Isso inclui:

  • GetAccountCompletedState: A conta foi recuperada com êxito.
  • GetAccountFailedState: falha na recuperação da conta.
MfaRequestChallengeResultState

Os estados possíveis para o MfaRequestChallengeResult. Isso inclui:

  • MfaVerificationRequiredState: o usuário precisa verificar seu desafio.
  • MfaFailedState: falha na solicitação de MFA.
MfaSubmitChallengeResultState
ResetPasswordInputs
ResetPasswordResendCodeResultState

Os estados possíveis para o ResetPasswordResendCodeResult. Isso inclui:

  • ResetPasswordCodeRequiredState: o processo de redefinição de senha requer um código.
  • ResetPasswordFailedState: o processo de redefinição de senha falhou.
ResetPasswordStartResultState

Os estados possíveis para o ResetPasswordStartResult. Isso inclui:

  • ResetPasswordCodeRequiredState: o processo de redefinição de senha requer um código.
  • ResetPasswordFailedState: o processo de redefinição de senha falhou.
ResetPasswordSubmitCodeResultState

Os estados possíveis para o ResetPasswordSubmitCodeResult. Isso inclui:

  • ResetPasswordPasswordRequiredState: o processo de redefinição de senha requer uma senha.
  • ResetPasswordFailedState: o processo de redefinição de senha falhou.
ResetPasswordSubmitPasswordResultState

Os estados possíveis para o ResetPasswordSubmitPasswordResult. Isso inclui:

  • ResetPasswordCompletedState: o processo de redefinição de senha foi concluído com êxito.
  • ResetPasswordFailedState: o processo de redefinição de senha falhou.
SignInInputs
SignInResendCodeResultState

Os estados possíveis para o SignInResendCodeResult. Isso inclui:

  • SignInCodeRequiredState: o processo de entrada requer um código.
  • SignInFailedState: o processo de entrada falhou.
SignInResultState

Os estados possíveis para o SignInResult. Isso inclui:

  • SignInCodeRequiredState: o processo de entrada requer um código.
  • SignInPasswordRequiredState: o processo de entrada requer uma senha.
  • SignInFailedState: o processo de entrada falhou.
  • SignInCompletedState: o processo de entrada foi concluído.
  • AuthMethodRegistrationRequiredState: o processo de entrada requer o registro do método de autenticação.
  • MfaAwaitingState: o processo de entrada requer MFA.
SignInSubmitCodeResultState

Os estados possíveis do SignInSubmitCodeResult. Isso inclui:

  • SignInCompletedState: o processo de entrada foi concluído com êxito.
  • SignInFailedState: o processo de entrada falhou.
  • AuthMethodRegistrationRequiredState: o usuário precisa registrar um método de autenticação.
  • MfaAwaitingState: o usuário está em um estado de espera de MFA (autenticação multifator).
SignInSubmitPasswordResultState

Os estados possíveis do SignInSubmitPasswordResult. Isso inclui:

  • SignInCompletedState: o processo de entrada foi concluído com êxito.
  • SignInFailedState: o processo de entrada falhou.
  • AuthMethodRegistrationRequiredState: o processo de entrada requer o registro do método de autenticação.
  • MfaAwaitingState: o processo de entrada requer MFA.
SignInWithContinuationTokenInputs
SignOutResultState

Os estados possíveis para o SignOutResult. Isso inclui:

  • SignOutCompletedState: A operação de saída foi bem-sucedida.
  • SignOutFailedState: falha na operação de saída.
SignUpInputs
SignUpResendCodeResultState

Os estados possíveis para o SignUpResendCodeResult. Isso inclui:

  • SignUpCodeRequiredState: o processo de inscrição requer um código.
  • SignUpFailedState: o processo de inscrição falhou.
SignUpResultState

Os estados possíveis para o SignUpResult. Isso inclui:

  • SignUpCodeRequiredState: o processo de inscrição requer um código.
  • SignUpPasswordRequiredState: o processo de inscrição requer uma senha.
  • SignUpAttributesRequiredState: o processo de inscrição requer atributos adicionais.
  • SignUpFailedState: o processo de inscrição falhou.
SignUpSubmitAttributesResultState

Os estados possíveis para o SignUpSubmitAttributesResult. Isso inclui:

  • SignUpCompletedState: o processo de inscrição foi concluído com êxito.
  • SignUpFailedState: o processo de inscrição falhou.
SignUpSubmitCodeResultState

Os estados possíveis para o SignUpSubmitCodeResult. Isso inclui:

  • SignUpPasswordRequiredState: o processo de inscrição requer uma senha.
  • SignUpAttributesRequiredState: o processo de inscrição requer atributos adicionais.
  • SignUpCompletedState: o processo de inscrição foi concluído com êxito.
  • SignUpFailedState: o processo de inscrição falhou.
SignUpSubmitPasswordResultState

Os estados possíveis para o SignUpSubmitPasswordResult. Isso inclui:

  • SignUpAttributesRequiredState: o processo de inscrição requer atributos adicionais.
  • SignUpCompletedState: o processo de inscrição foi concluído com êxito.
  • SignUpFailedState: o processo de inscrição falhou.
UserAccountAttributes

Enumerações

InteractionType
PerformanceEvents

A enumeração de operações instrumentadas tem seu desempenho medido pelo PerformanceClient.

LogLevel

Nível de mensagem de log.

Funções

createNestablePublicClientApplication(Configuration)

cria NestedAppAuthController e o passa para o PublicClientApplication, retorna para StandardController se NestedAppAuthController não estiver disponível

createStandardPublicClientApplication(Configuration)

cria PublicClientApplication usando StandardController

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

Verifica se o agente da plataforma está disponível no ambiente atual.

Variáveis

ApiId

Códigos de API para fins de telemetria. 0-99 Fluxo Silencioso 800-899 Fluxo de Código de Autenticação 900-999 Diversos

AuthenticationScheme

Tipo da solicitação de autenticação

AzureCloudInstance
BrowserCacheLocation
CacheLookupPolicy
EventType
InteractionStatus

Tipos de interação atualmente em andamento. Usado em eventos em bibliotecas de wrapper para invocar funções quando determinada interação estiver em andamento ou todas as interações forem concluídas.

JsonWebTokenTypes
ProtocolMode

Modos de protocolo compatíveis com a MSAL.

ServerResponseType

valores permitidos para o tipo de resposta do servidor

WrapperSKU
AuthErrorMessage

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

BrowserAuthErrorMessage

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

BrowserConfigurationAuthErrorMessage

Classe BrowserAuthErrorMessage 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.

DEFAULT_IFRAME_TIMEOUT_MS
InteractionRequiredAuthErrorMessage

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

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

stubbedPublicClientApplication
version

Detalhes da função

createNestablePublicClientApplication(Configuration)

cria NestedAppAuthController e o passa para o PublicClientApplication, retorna para StandardController se NestedAppAuthController não estiver disponível

function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parâmetros

configuration
Configuration

Retornos

IPublicClientApplication

createStandardPublicClientApplication(Configuration)

cria PublicClientApplication usando StandardController

function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parâmetros

configuration
Configuration

Retornos

IPublicClientApplication

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

Verifica se o agente da plataforma está disponível no ambiente atual.

function isPlatformBrokerAvailable(loggerOptions?: LoggerOptions, perfClient?: IPerformanceClient, correlationId?: string, domConfig?: boolean): Promise<boolean>

Parâmetros

loggerOptions
LoggerOptions
perfClient
IPerformanceClient
correlationId

string

domConfig

boolean

Retornos

Promise<boolean>

Detalhes da variável

ApiId

Códigos de API para fins de telemetria. 0-99 Fluxo Silencioso 800-899 Fluxo de Código de Autenticação 900-999 Diversos

ApiId: { acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }

Tipo

{ acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }

AuthenticationScheme

Tipo da solicitação de autenticação

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

Tipo

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

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

BrowserCacheLocation

BrowserCacheLocation: { LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

Tipo

{ LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

CacheLookupPolicy

CacheLookupPolicy: { AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

Tipo

{ AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

EventType

EventType: { ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }

Tipo

{ ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }

InteractionStatus

Tipos de interação atualmente em andamento. Usado em eventos em bibliotecas de wrapper para invocar funções quando determinada interação estiver em andamento ou todas as interações forem concluídas.

InteractionStatus: { AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

Tipo

{ AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

JsonWebTokenTypes

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

Tipo

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

ProtocolMode

Modos de protocolo compatíveis com a MSAL.

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

Tipo

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

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

WrapperSKU

WrapperSKU: { Angular: "@azure/msal-angular", React: "@azure/msal-react" }

Tipo

{ Angular: "@azure/msal-angular", React: "@azure/msal-react" }

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 } }

BrowserAuthErrorMessage

Aviso

Essa API foi preterida.

Use exported BrowserAuthErrorCodes instead. In your app you can do :

import { BrowserAuthErrorCodes } from "@azure/msal-browser";

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

BrowserAuthErrorMessage: { authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }

Tipo

{ authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }

BrowserConfigurationAuthErrorMessage

Aviso

Essa API foi preterida.

Use BrowserAuthErrorCodes instead

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

BrowserConfigurationAuthErrorMessage: { inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { code: string, desc: string } }

Tipo

{ inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { 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 } }

DEFAULT_IFRAME_TIMEOUT_MS

DEFAULT_IFRAME_TIMEOUT_MS: 10000

Tipo

10000

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[]

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 }

stubbedPublicClientApplication

stubbedPublicClientApplication: IPublicClientApplication

Tipo

version

version: "4.30.0"

Tipo

"4.30.0"