@azure/msal-browser package
Classes
| AuthError |
Classe de erro geral lançada pela biblioteca MSAL.js. |
| AuthenticationHeaderParser |
Esta é uma classe auxiliar que analisa cabeçalhos de autenticação de resposta HTTP suportados para extrair e devolver valores de desafio de cabeçalho que podem ser usados fora dos fluxos básicos de autorização. |
| BrowserAuthError |
Classe de erro da biblioteca do navegador lançada pela biblioteca MSAL.js para SPAs |
| BrowserConfigurationAuthError |
Classe de erro da biblioteca do navegador lançada pela biblioteca MSAL.js para SPAs |
| BrowserPerformanceClient | |
| BrowserPerformanceMeasurement | |
| ClientAuthError |
Erro lançado quando há um erro no código do cliente a correr no navegador. |
| ClientConfigurationError |
Erro lançado quando há um erro na configuração da biblioteca MSAL.js. |
| EventHandler | |
| EventMessageUtils | |
| InteractionRequiredAuthError |
Erro lançado quando a interação do utilizador é necessária. |
| LocalStorage | |
| Logger |
Classe que facilita o registo de mensagens num local específico. |
| MemoryStorage | |
| NavigationClient | |
| PublicClientApplication |
A classe PublicClientApplication é o objeto exposto pela biblioteca para realizar funções de autenticação e autorização em Aplicações de Página Única, para obter tokens JWT conforme descrito no OAuth 2.0 Authorization Code Flow com especificação PKCE. |
| PublicClientNext |
O PublicClientNext é uma análise inicial da implementação planeada do PublicClientApplication na próxima grande versão do MSAL.js. Contém suporte para múltiplas implementações de API baseadas no ambiente de execução em que está a correr. Os objetivos destas alterações são proporcionar uma separação limpa de comportamentos entre diferentes contextos operacionais (Autenticação de Aplicações Aninhada, Brokers de Plataforma, Navegador Tradicional, etc.), mantendo ao mesmo tempo uma superfície de API consistente para os programadores. Por favor, use o PublicClientApplication para qualquer cenário de produção/do mundo real. Nota: O PublicClientNext é experimental e sujeito a alterações urgentes sem seguir o semestre |
| ServerError |
Erro lançado quando há um erro no código do servidor, por exemplo, indisponibilidade. |
| SessionStorage | |
| SignedHttpRequest | |
| StubPerformanceClient | |
| UrlString |
A classe de objeto URL pode realizar várias transformações em strings de URL. |
| AuthFlowActionRequiredStateBase |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| AuthFlowStateBase |
Classe base para o estado de um fluxo de autenticação. |
| AuthMethodRegistrationChallengeMethodError |
Erro que ocorreu durante o pedido de desafio do método de autenticação. |
| AuthMethodRegistrationChallengeMethodResult |
Resultado de contestar um método de autenticação para registo. Utiliza o tipo de estado base para evitar dependências circulares. |
| AuthMethodRegistrationCompletedState |
Indique que o processo de registo do método de autenticação foi concluído com sucesso. |
| AuthMethodRegistrationFailedState |
Estado indicando que o fluxo de registo do método de autenticação falhou. |
| AuthMethodRegistrationRequiredState |
Estado indica que é necessário o registo do método de autenticação. |
| AuthMethodRegistrationSubmitChallengeError |
Erro que ocorreu durante a submissão do desafio do método de autenticação. |
| AuthMethodRegistrationSubmitChallengeResult |
Resultado de submeter um desafio para o registo do método de autenticação. |
| AuthMethodVerificationRequiredState |
Estado indicando que a verificação é necessária para o método de autenticação contestado. |
| 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 erros no token de acesso à conta corrente. |
| HttpError | |
| InvalidArgumentError | |
| InvalidConfigurationError | |
| MethodNotImplementedError | |
| MfaAwaitingState |
Estado indicando que a MFA é necessária e aguarda ação do utilizador. Este estado permite ao programador pausar a execução antes de enviar o código para o email do utilizador. |
| MfaCompletedState |
Estado indicando que o fluxo MFA foi concluído com sucesso. |
| MfaFailedState |
Estado indicando que o fluxo MFA falhou. |
| MfaRequestChallengeError |
Erro que ocorreu durante o pedido de desafio MFA. |
| MfaRequestChallengeResult |
Resultado de pedir um desafio de MFA. Utiliza o tipo de estado base para evitar dependências circulares. |
| MfaSubmitChallengeError |
Erro que ocorreu durante a submissão do desafio MFA. |
| MfaSubmitChallengeResult |
Resultado de submeter um desafio de MFA. |
| MfaVerificationRequiredState |
Indique que a verificação MFA é necessária. O desafio foi enviado e o utilizador precisa de fornecer o código. |
| MsalCustomAuthError | |
| NoCachedAccountFoundError | |
| ParsedUrlError | |
| ResetPasswordCodeRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| ResetPasswordCompletedState |
Representa o estado que indica a conclusão bem-sucedida de uma operação de redefinição de palavra-passe. |
| ResetPasswordError | |
| ResetPasswordFailedState |
Estado de uma operação de redefinição de palavra-passe que falhou. |
| ResetPasswordPasswordRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| ResetPasswordResendCodeError | |
| ResetPasswordResendCodeResult | |
| ResetPasswordStartResult | |
| ResetPasswordState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| ResetPasswordSubmitCodeError | |
| ResetPasswordSubmitCodeResult | |
| ResetPasswordSubmitPasswordError | |
| ResetPasswordSubmitPasswordResult | |
| SignInCodeRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignInCompletedState |
Representa o estado concluído da operação de entrada. Este estado indica que o processo de registo foi concluído com sucesso. |
| SignInContinuationState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignInError | |
| SignInFailedState |
Representa o estado de uma operação de início de sessão que foi falhada. |
| SignInPasswordRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignInResendCodeError | |
| SignInResendCodeResult | |
| SignInResult | |
| SignInState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignInSubmitCodeError | |
| SignInSubmitCodeResult | |
| SignInSubmitPasswordError | |
| SignInSubmitPasswordResult | |
| SignOutError |
A classe de erro para erros de saída de sessão. |
| SignOutResult | |
| SignUpAttributesRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignUpCodeRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignUpCompletedState |
Representa o estado de uma operação de inscrição que foi concluída com sucesso. |
| SignUpError | |
| SignUpFailedState |
Representa o estado de uma operação de inscrição que falhou. |
| SignUpPasswordRequiredState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignUpResendCodeError | |
| SignUpResendCodeResult | |
| SignUpResult | |
| SignUpState |
Classe base para o estado requerido de ação num fluxo de autenticação. |
| SignUpSubmitAttributesError | |
| SignUpSubmitAttributesResult | |
| SignUpSubmitCodeError | |
| SignUpSubmitCodeResult | |
| SignUpSubmitPasswordError | |
| SignUpSubmitPasswordResult | |
| UnexpectedError | |
| UnsupportedEnvironmentError | |
| UserAccountAttributeError | |
| UserAlreadySignedInError | |
Interfaces
| IController | |
| ILoggerCallback | |
| INavigationClient | |
| INetworkModule |
Interface de rede cliente para enviar pedidos de backend. |
| IPerformanceClient | |
| IPublicClientApplication | |
| ITokenCache | |
| IWindowStorage | |
| AuthMethodDetails |
Detalhes para um método de autenticação a ser registado. |
| AuthenticationMethod | |
| ICustomAuthPublicClientApplication | |
Aliases de Tipo
| AccountInfo |
Objeto de conta com a seguinte assinatura:
|
| AuthenticationResult | |
| AuthorizationCodeRequest | |
| AuthorizationUrlRequest |
Este tipo está obsoleto e será removido na próxima grande atualização de versão |
| AzureCloudOptions |
Opções específicas do AzureCloudInstance
|
| BrokerConnectionEvent |
Carga útil para o evento BrokerConnectionEstablished |
| BrowserAuthOptions |
Use isto para configurar as opções de autenticação no objeto Configuration |
| BrowserSystemOptions | |
| BrowserTelemetryOptions |
Opções de Telemetria |
| CacheOptions |
Use isto para configurar as opções de configuração de cache abaixo: |
| ClearCacheRequest |
ClearCacheRequest
|
| Configuration |
Este objeto permite-lhe configurar elementos importantes da funcionalidade MSAL e é passado para o construtor do PublicClientApplication |
| EndSessionPopupRequest |
FimSessãoPopupPedido
|
| EndSessionRequest |
FimSolicitoSessão
|
| EventCallbackFunction | |
| EventError | |
| EventMessage | |
| EventPayload | |
| ExternalTokenResponse |
Objeto de resposta usado para carregar tokens externos em cache.
|
| IdTokenClaims |
Tipo que descreve as reivindicações do Id Token conhecidas pela MSAL. |
| InProgressPerformanceEvent | |
| InitializeApplicationRequest |
InitializeApplicationRequest: Objeto de pedido passado pelo utilizador para inicializar a aplicação
|
| LoadTokenOptions | |
| NavigationOptions |
Informação adicional passada para as funções navegateInternal e navigateExternal |
| NetworkRequestOptions |
Opções permitidas por APIs de pedidos de rede. |
| NetworkResponse | |
| PerformanceCallbackFunction | |
| PerformanceEvent |
Medição de desempenho realizada pela biblioteca, incluindo metadados sobre o pedido e a aplicação. |
| PopupEvent | |
| PopupPosition | |
| PopupRequest |
PopupRequest: Pedido de objeto passado pelo utilizador 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.
|
| PopupSize | |
| PopupWindowAttributes |
Configurações de popup para definir dimensões e posição da janela popup |
| RedirectRequest |
RedirectRequest: Objeto de pedido passado pelo utilizador 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 completa.
|
| SignedHttpRequestOptions | |
| SilentRequest |
SilentRequest: Objeto de pedido passado pelo utilizador para recuperar tokens da 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) num iframe oculto.
|
| SsoSilentRequest |
Objeto de pedido passado pelo utilizador para o ssoSilent para recuperar um Código do servidor (primeira etapa do fluxo de concessão de código de autorização)
|
| TenantProfile |
Detalhes da conta que variam entre inquilinos para o mesmo utilizador |
| AccessTokenRetrievalInputs | |
| AccountRetrievalInputs | |
| AuthMethodRegistrationChallengeMethodResultState |
Definição de tipo para possíveis estados em AuthMethodRegistrationChallengeMethodResult. |
| AuthMethodRegistrationSubmitChallengeResultState |
Definição de tipo para possíveis estados em AuthMethodRegistrationSubmitChallengeResult. |
| CustomAuthConfiguration | |
| GetAccessTokenResultState |
Os possíveis estados para o GetAccessTokenResult. Isto inclui:
|
| GetAccountResultState |
Os possíveis estados para o GetAccountResult. Isto inclui:
|
| MfaRequestChallengeResultState |
Os estados possíveis para o MfaRequestChallengeResult. Isto inclui:
|
| MfaSubmitChallengeResultState | |
| ResetPasswordInputs | |
| ResetPasswordResendCodeResultState |
Os possíveis estados para o ResetPasswordResendCodeResult. Isto inclui:
|
| ResetPasswordStartResultState |
Os possíveis estados para o ResetPasswordStartResult. Isto inclui:
|
| ResetPasswordSubmitCodeResultState |
Os possíveis estados para o ResetPasswordSubmitCodeResult. Isto inclui:
|
| ResetPasswordSubmitPasswordResultState |
Os possíveis estados para o ResetPasswordSubmitPasswordResult. Isto inclui:
|
| SignInInputs | |
| SignInResendCodeResultState |
Os estados possíveis para o SignInResendCodeResult. Isto inclui:
|
| SignInResultState |
Os estados possíveis para o ResultaIniciação. Isto inclui:
|
| SignInSubmitCodeResultState |
Os possíveis estados do SignInSubmitCodeResult. Isto inclui:
|
| SignInSubmitPasswordResultState |
Os possíveis estados do resultado LoginSubmitPassword. Isto inclui:
|
| SignInWithContinuationTokenInputs | |
| SignOutResultState |
Os possíveis estados para o SignOutResult. Isto inclui:
|
| SignUpInputs | |
| SignUpResendCodeResultState |
Os possíveis estados para o SignUpResendCodeResult. Isto inclui:
|
| SignUpResultState |
Os possíveis estados para o InscriçãoResultado. Isto inclui:
|
| SignUpSubmitAttributesResultState |
Os possíveis estados para o SignUpSubmitAttributesResult. Isto inclui:
|
| SignUpSubmitCodeResultState |
Os possíveis estados para o SignUpSubmitCodeResult. Isto inclui:
|
| SignUpSubmitPasswordResultState |
Os possíveis estados para o resultado SignUpSubmitPassword. Isto inclui:
|
| UserAccountAttributes | |
Enumerações
| InteractionType | |
| PerformanceEvents |
A enumeração das operações instrumentadas por tem o seu desempenho medido pelo PerformanceClient. |
| LogLevel |
Registar o nível da mensagem. |
Funções
| create |
cria o NestedAppAuthController e passa-o para o PublicClientApplication, voltando ao StandardController se o NestedAppAuthController não estiver disponível |
| create |
cria o PublicClientApplication usando o StandardController |
| is |
Verifica se o corretor da plataforma está disponível no ambiente atual. |
Variáveis
| Api |
Códigos API para fins de Telemetria. 0-99 Fluxo Silencioso 800-899 Código de Autentificação Fluxo 900-999 Diversos |
| Authentication |
Tipo do pedido de autenticação |
| Azure |
|
| Browser |
|
| Cache |
|
| Event |
|
| Interaction |
Tipos de interação em curso atualmente. Usado em eventos em bibliotecas de wrappers para invocar funções quando determinada interação está em curso ou todas as interações estão concluídas. |
| Json |
|
| Protocol |
Modos de protocolo suportados pelo MSAL. |
| Server |
Valores permitidos para o tipo de resposta do servidor |
| WrapperSKU | |
| Auth |
AuthErrorMessage classe contendo constantes de cadeia usadas por códigos de erro e mensagens. |
| Browser |
A classe BrowserAuthErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens. |
| Browser |
A classe BrowserAuthErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens. |
| Client |
Constantes de cadeia usadas por códigos de erro e mensagens. |
| Client |
A classe ClientConfigurationErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens. |
| DEFAULT_IFRAME_TIMEOUT_MS | |
| Interaction |
Interação requeria erros definidos pelo SDK |
| OIDC_DEFAULT_SCOPES | |
| Prompt |
Considerámos colocar este "enum" no pedido em vez de uma cadeia, no entanto, parece que a lista permitida de valores do prompt tem mudado nos últimos anos. Existem também alguns valores de prompt não documentados para alguns parceiros internos, daí a escolha do tipo genérico de "string" em vez do "enum" |
| stubbed |
|
| version |
Detalhes de Função
createNestablePublicClientApplication(Configuration)
cria o NestedAppAuthController e passa-o para o PublicClientApplication, voltando ao StandardController se o NestedAppAuthController não estiver disponível
function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Parâmetros
- configuration
- Configuration
Devoluções
Promise<IPublicClientApplication>
IPublicClienteApplication
createStandardPublicClientApplication(Configuration)
cria o PublicClientApplication usando o StandardController
function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Parâmetros
- configuration
- Configuration
Devoluções
Promise<IPublicClientApplication>
IPublicClienteApplication
isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)
Verifica se o corretor 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
Devoluções
Promise<boolean>
Detalhes das variáveis
ApiId
Códigos API para fins de Telemetria. 0-99 Fluxo Silencioso 800-899 Código de Autentificação Fluxo 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 do pedido 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 em curso atualmente. Usado em eventos em bibliotecas de wrappers para invocar funções quando determinada interação está em curso ou todas as interações estão 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 suportados pelo MSAL.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Tipo
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ServerResponseType
Aviso
Esta API foi preterida.
Use ResponseMode instead
Valores permitidos para o tipo de resposta do servidor
ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }
Tipo
{ FRAGMENT: "fragment", QUERY: "query" }
WrapperSKU
WrapperSKU: { Angular: "@azure/msal-angular", React: "@azure/msal-react" }
Tipo
{ Angular: "@azure/msal-angular", React: "@azure/msal-react" }
AuthErrorMessage
Aviso
Esta API foi preterida.
Use AuthErrorCodes instead
AuthErrorMessage classe contendo constantes de cadeia usadas por códigos de erro e mensagens.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Tipo
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
BrowserAuthErrorMessage
Aviso
Esta API foi preterida.
Use exported BrowserAuthErrorCodes instead. In your app you can do :
import { BrowserAuthErrorCodes } from "@azure/msal-browser";
A classe BrowserAuthErrorMessage contém constantes de cadeia 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
Esta API foi preterida.
Use BrowserAuthErrorCodes instead
A classe BrowserAuthErrorMessage contém constantes de cadeia 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
Esta API foi preterida.
Use ClientAuthErrorCodes instead
Constantes de cadeia usadas por códigos de erro e mensagens.
ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }
Tipo
{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }
ClientConfigurationErrorMessage
Aviso
Esta API foi preterida.
Use ClientConfigurationErrorCodes instead
A classe ClientConfigurationErrorMessage contém constantes de cadeia usadas por códigos de erro e mensagens.
ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }
Tipo
{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }
DEFAULT_IFRAME_TIMEOUT_MS
DEFAULT_IFRAME_TIMEOUT_MS: 10000
Tipo
10000
InteractionRequiredAuthErrorMessage
Aviso
Esta API foi preterida.
Use InteractionRequiredAuthErrorCodes instead
Interação requeria erros definidos pelo SDK
InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }
Tipo
{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }
OIDC_DEFAULT_SCOPES
OIDC_DEFAULT_SCOPES: string[]
Tipo
string[]
PromptValue
Considerámos colocar este "enum" no pedido em vez de uma cadeia, no entanto, parece que a lista permitida de valores do prompt tem mudado nos últimos anos. Existem também alguns valores de prompt não documentados para alguns parceiros internos, daí a escolha do tipo genérico de "string" em vez do "enum"
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
Tipo
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
stubbedPublicClientApplication
version
version: "4.30.0"
Tipo
"4.30.0"