IPublicClientApplication interface

Interface para a classe PublicClientApplication que define as assinaturas públicas da API

Métodos

acquireTokenByCode(AuthorizationCodeRequest)

Adquire um token trocando o código de autorização recebido na primeira etapa do OAuth 2.0 Authorization Code Flow

acquireTokenByDeviceCode(DeviceCodeRequest)

Adquire um token da autoridade usando o fluxo de código do dispositivo OAuth2.0

acquireTokenByRefreshToken(RefreshTokenRequest)

Adquire um token trocando o token de atualização fornecido por um novo conjunto de tokens

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Adquire tokens com concessão de palavra-passe trocando o nome de utilizador e a palavra-passe da aplicação cliente por credenciais

acquireTokenInteractive(InteractiveRequest)

Adquire um token de forma interativa

acquireTokenSilent(SilentFlowRequest)

Adquire um token silenciosamente quando um utilizador especifica a conta para a qual o token é solicitado

clearCache()

Limpar o cache

getAllAccounts()

Obtém todas as contas em cache

getAuthCodeUrl(AuthorizationUrlRequest)

Cria a URL do pedido de autorização

getLogger()

Devolve a instância do logger

getTokenCache()

Obtém a cache de tokens da aplicação

setLogger(Logger)

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

signOut(SignOutRequest)

Remove artefactos de cache associados à conta dada

Detalhes de Método

acquireTokenByCode(AuthorizationCodeRequest)

Adquire um token trocando o código de autorização recebido na primeira etapa do OAuth 2.0 Authorization Code Flow

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

Parâmetros

Devoluções

acquireTokenByDeviceCode(DeviceCodeRequest)

Adquire um token da autoridade usando o fluxo de código do dispositivo OAuth2.0

function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>

Parâmetros

Devoluções

Promise<null | AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

Adquire um token trocando o token de atualização fornecido por um novo conjunto de tokens

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

Parâmetros

Devoluções

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Aviso

Esta API foi preterida.

  • Use a more secure flow instead

Adquire tokens com concessão de palavra-passe trocando o nome de utilizador e a palavra-passe da aplicação cliente por credenciais

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

Parâmetros

Devoluções

Promise<null | AuthenticationResult>

acquireTokenInteractive(InteractiveRequest)

Adquire um token de forma interativa

function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>

Parâmetros

Devoluções

acquireTokenSilent(SilentFlowRequest)

Adquire um token silenciosamente quando um utilizador especifica a conta para a qual o token é solicitado

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

Parâmetros

Devoluções

clearCache()

Limpar o cache

function clearCache()

getAllAccounts()

Obtém todas as contas em cache

function getAllAccounts(): Promise<AccountInfo[]>

Devoluções

Promise<AccountInfo[]>

getAuthCodeUrl(AuthorizationUrlRequest)

Cria a URL do pedido de autorização

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

Parâmetros

Devoluções

Promise<string>

getLogger()

Devolve a instância do logger

function getLogger(): Logger

Devoluções

getTokenCache()

Obtém a cache de tokens da aplicação

function getTokenCache(): TokenCache

Devoluções

setLogger(Logger)

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

function setLogger(logger: Logger)

Parâmetros

logger
Logger

signOut(SignOutRequest)

Remove artefactos de cache associados à conta dada

function signOut(request: SignOutRequest): Promise<void>

Parâmetros

request
SignOutRequest

Devoluções

Promise<void>