CustomAuthPublicClientApplication class

Cria uma nova instância de um PublicClientApplication com a configuração e controlador fornecidos para iniciar fluxos de autenticação nativa

static function create(config: CustomAuthConfiguration): Promise<ICustomAuthPublicClientApplication>

Parâmetros

Devoluções

• Uma promessa que se resolve para uma instância CustomAuthPublicClientApplication

Obtém a conta atual da cache do navegador.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parâmetros

Devoluções

• O resultado da operação da conta get

Inicia o fluxo de redefinição de palavra-passe. Este método resulta em acionar uma ação extra (submeter código) para completar a palavra-passe de redefinição. Crie o resultado com detalhes de erro se houver alguma exceção.

function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>

Parâmetros

Devoluções

• Uma promessa que resolve para ResetarPasswordInícioResultado

Inicia o fluxo de entrada. Este método resulta na conclusão do login, ou na necessidade de ações extra (password, código, etc.) para completar o login. Crie o resultado com detalhes de erro se houver alguma exceção.

function signIn(signInInputs: SignInInputs): Promise<SignInResult>

Parâmetros

Devoluções

• Uma promessa que se resolve para LogInResult

Inicia o processo de inscrição. Este método resulta na conclusão da inscrição, ou na necessidade de ações extra (palavra-passe, código, etc.) para concluir a inscrição. Crie o resultado com detalhes de erro se houver alguma exceção.

function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>

Parâmetros

Devoluções

• Uma promessa que se resolve para o SignUpResult

Esta função resgata um código de autorização (passado como código) do endpoint do token eSTS. Este código de autorização deve ser adquirido do lado do servidor usando um cliente confidencial para adquirir um spa_code. Esta API não está indefinida para aquisição e resgate normais de código de autorização.

A resgate deste código de autorização não requerrá PKCE, pois foi adquirido por um cliente confidencial.

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Parâmetros

Devoluções

Uma promessa que é cumprida quando esta função está concluída, ou rejeitada se foi levantado um erro.

Herdado de PublicClientApplication.acquireTokenByCode

Use quando quiser obter uma access_token para a sua API abrindo uma janela pop-up no navegador do utilizador

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

Parâmetros

Devoluções

Uma promessa que é cumprida quando esta função está concluída, ou rejeitada se foi levantado um erro.

Herdado de PublicClientApplication.acquireTokenPopup

Use quando quiser obter um access_token para a sua API, redirecionando a janela do navegador do utilizador para o endpoint de autorização. Esta função redireciona a página, por isso qualquer código que siga esta função não será executado.

IMPORTANTE: NÃO é recomendado ter código dependente da resolução da Promessa. Esta função irá navegar para fora da janela atual do navegador. Atualmente, devolve uma Promessa para refletir a natureza assíncrona do código a correr nesta função.

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.acquireTokenRedirect

Adquira silenciosamente um token de acesso para um dado conjunto de miras. As devoluções atualmente a processar prometem se forem feitas solicitações paralelas.

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

Parâmetros

Devoluções

• uma promessa que é cumprida quando esta função está concluída, ou rejeitada se foi apontado um erro. Devolve o AuthenticationResult objeto

Herdado de PublicClientApplication.acquireTokenSilent

Adiciona callbacks de eventos ao array

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

Parâmetros

Devoluções

Herdado de PublicClientApplication.addEventCallback

Regista uma chamada de retorno para receber eventos de atuação.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parâmetros

Devoluções

Herdado de PublicClientApplication.addPerformanceCallback

Limpa tokens e conta da cache do navegador.

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.clearCache

Cria o StandardController e passa-o para a PublicClientApplication

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parâmetros

Devoluções

Herdado de PublicClienteApplication.createPublicClientApplication

Remove o ouvinte de eventos que emite um evento quando uma conta de utilizador é adicionada ou removida do armazenamento local numa aba ou janela diferente do navegador

function disableAccountStorageEvents()

Herdado de PublicClienteApplication.disableAccountStorageEvents

Adiciona um ouvinte de eventos que emite um evento quando uma conta de utilizador é adicionada ou removida do armazenamento local numa aba ou janela diferente do navegador

function enableAccountStorageEvents()

Herdado de PublicClientApplication.enableAccountStorageEvents

Devolve a primeira conta encontrada na cache que corresponde ao filtro de conta passado.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parâmetros

Devoluções

A primeira conta encontrada na cache corresponde ao filtro fornecido ou nula caso nenhuma tenha sido encontrada.

Herdado de PublicClientApplication.getAccount

Devolve a conta iniciada correspondente ao homeAccountId. (o objeto da conta é criado no momento do início de sessão bem-sucedido) ou nulo quando não é encontrada nenhuma conta correspondente

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parâmetros

Devoluções

O objeto da conta armazenado no MSAL

Herdado de PublicClientApplication.getAccountByHomeId

Devolve a conta iniciada correspondente ao localAccountId. (o objeto da conta é criado no momento do início de sessão bem-sucedido) ou nulo quando não é encontrada nenhuma conta correspondente

function getAccountByLocalId(localId: string): null | AccountInfo

Parâmetros

Devoluções

O objeto da conta armazenado no MSAL

Herdado de PublicClientApplication.getAccountByLocalId

Devolve a conta iniciada correspondente ao nome de utilizador. (o objeto de conta é criado no momento do início de sessão bem-sucedido) ou nulo quando não é encontrada nenhuma conta correspondente. Esta API é fornecida por conveniência, mas o getAccountById deve ser usado para maior fiabilidade

function getAccountByUsername(userName: string): null | AccountInfo

Parâmetros

Devoluções

O objeto da conta armazenado no MSAL

Herdado de PublicClientApplication.getAccountByUsername

Obtém a conta atualmente ativa

function getActiveAccount(): null | AccountInfo

Devoluções

Herdado de PublicClienteApplication.getActiveAccount

Devolve todas as contas na cache que correspondem ao filtro opcional. Se não for fornecido filtro, todas as contas são devolvidas.

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

Parâmetros

Devoluções

Array de objetos AccountInfo na cache

Herdado de PublicClienteApplication.getAllAccounts

Devolve a instância do logger

function getLogger(): Logger

Devoluções

Herdado de PublicClientApplication.getLogger

Obtém o token cache da aplicação.

function getTokenCache(): ITokenCache

Devoluções

Herdado de PublicClientApplication.getTokenCache

Função de gestor de eventos que permite aos utilizadores lançar eventos depois de o objeto PublicClientApplication ter sido carregado durante os fluxos de redirecionamento. Isto deve ser invocado em todas as cargas de página envolvidas nos fluxos de autenticação de redirecionamento.

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

Parâmetros

Devoluções

Resposta de token ou nula. Se o valor de retorno for nulo, então não foi detetado nenhum redirecionamento de autenticação.

Herdado de PublicClienteApplication.handleRedirectPromise

Hydrates armazena cache com os tokens e a conta no objeto AuthenticationResult

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.hydrateCache

Função inicializadora para realizar tarefas de arranque assíncronas, como a ligação à extensão WAM

function initialize(request?: InitializeApplicationRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.initialize

Chamado por bibliotecas de wrapper (Angular & React) para definir SKU e Versão passada para telemetria, logger, etc.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parâmetros

Herdado de PublicClientApplication.initializeWrapperLibrary

Use ao iniciar o processo de login, abrindo uma janela pop-up no navegador do utilizador

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

Parâmetros

Devoluções

Uma promessa que é cumprida quando esta função está concluída, ou rejeitada se foi levantado um erro.

Herdado de PublicClientApplication.loginPopup

Use ao iniciar o processo de login, redirecionando o navegador do utilizador para o endpoint de autorização. Esta função redireciona a página, por isso qualquer código que siga esta função não será executado.

IMPORTANTE: NÃO é recomendado ter código dependente da resolução da Promessa. Esta função irá navegar para fora da janela atual do navegador. Atualmente, devolve uma Promessa para refletir a natureza assíncrona do código a correr nesta função.

function loginRedirect(request?: RedirectRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.loginRedirecionar

Função de logout descontinuada. Use logoutRedirect ou logoutPopup em vez disso

function logout(logoutRequest?: EndSessionRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.logout

Limpa a cache local do utilizador atual e depois abre uma janela pop-up a pedir ao utilizador para sair do servidor

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.logoutPopup

Use para fazer logout do utilizador atual e redirecionar o utilizador para o postLogoutRedirectUri. O comportamento padrão é redirecionar o utilizador para window.location.href.

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

Parâmetros

Devoluções

Herdado de PublicClientApplication.logoutRedirecionar

Remove callback com id fornecido do callback array

function removeEventCallback(callbackId: string)

Parâmetros

Herdado de PublicClientApplication.removeEventCallback

Remove um callback registado com o addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parâmetros

Devoluções

Herdado de PublicClientApplication.removePerformanceCallback

Define a conta para ser usada como a conta ativa. Se nenhuma conta for passada para as APIs do AcquireToken, a MSAL utilizará esta conta ativa.

function setActiveAccount(account: null | AccountInfo)

Parâmetros

Herdado de PublicClientApplication.setActiveAccount

Substitui o conjunto de logger predefinido em configurações por um novo Logger por novas configurações

function setLogger(logger: Logger)

Parâmetros

Herdado de PublicClientApplication.setLogger

Cliente de navegação de conjuntos

function setNavigationClient(navigationClient: INavigationClient)

Parâmetros

Herdado de PublicClientApplication.setNavigationClient

Esta função utiliza um iframe oculto para obter um código de autorização do eSTS. Existem casos em que isto pode não funcionar:

• Qualquer navegador que utilize uma forma de Prevenção de Rastreio Inteligente
• Se não houver uma sessão estabelecida com o serviço

Nestes casos, o pedido deve ser feito dentro de um popup ou redirecionamento full frame.

Nos casos em que é necessária interação, não pode enviar um pedido com prompt=nenhum.

Se o seu token de atualização expirou, pode usar esta função para obter silenciosamente um novo conjunto de tokens, desde que a sua sessão no servidor ainda exista.

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

Parâmetros

Devoluções

Uma promessa que é cumprida quando esta função está concluída, ou rejeitada se foi levantado um erro.

Herdado de PublicClientApplication.ssoSilent