IPublicClientApplication interface

Interface para a classe PublicClientApplication definindo as assinaturas da API pública

Métodos

acquireTokenByCode(AuthorizationCodeRequest)

Adquire um token trocando o código de autorização recebido da primeira etapa do Fluxo de Código de Autorização do OAuth 2.0

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 para um novo conjunto de tokens

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Adquire tokens com concessão de senha trocando nome de usuário e senha de aplicativos cliente por credenciais

acquireTokenInteractive(InteractiveRequest)

Adquire um token interativamente

acquireTokenSilent(SilentFlowRequest)

Adquire um token silenciosamente quando um usuário especifica a conta para a qual o token é solicitado

clearCache()

Limpar o cache

getAllAccounts()

Obtém todas as contas armazenadas em cache

getAuthCodeUrl(AuthorizationUrlRequest)

Cria a URL da solicitação de autorização

getLogger()

Retorna a instância do agente

getTokenCache()

Obtém o cache de token para o aplicativo

setLogger(Logger)

Substitui o conjunto de agentes padrão nas configurações pelo novo Agente por novas configurações

signOut(SignOutRequest)

Remove artefatos de cache associados à conta fornecida

Detalhes do método

acquireTokenByCode(AuthorizationCodeRequest)

Adquire um token trocando o código de autorização recebido da primeira etapa do Fluxo de Código de Autorização do OAuth 2.0

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

Parâmetros

Retornos

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

Retornos

Promise<null | AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

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

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

Parâmetros

Retornos

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Aviso

Essa API foi preterida.

  • Use a more secure flow instead

Adquire tokens com concessão de senha trocando nome de usuário e senha de aplicativos cliente por credenciais

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

Parâmetros

Retornos

Promise<null | AuthenticationResult>

acquireTokenInteractive(InteractiveRequest)

Adquire um token interativamente

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

Parâmetros

Retornos

acquireTokenSilent(SilentFlowRequest)

Adquire um token silenciosamente quando um usuário especifica a conta para a qual o token é solicitado

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

Parâmetros

Retornos

clearCache()

Limpar o cache

function clearCache()

getAllAccounts()

Obtém todas as contas armazenadas em cache

function getAllAccounts(): Promise<AccountInfo[]>

Retornos

Promise<AccountInfo[]>

getAuthCodeUrl(AuthorizationUrlRequest)

Cria a URL da solicitação de autorização

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

Parâmetros

Retornos

Promise<string>

getLogger()

Retorna a instância do agente

function getLogger(): Logger

Retornos

getTokenCache()

Obtém o cache de token para o aplicativo

function getTokenCache(): TokenCache

Retornos

setLogger(Logger)

Substitui o conjunto de agentes padrão nas configurações pelo novo Agente por novas configurações

function setLogger(logger: Logger)

Parâmetros

logger
Logger

signOut(SignOutRequest)

Remove artefatos de cache associados à conta fornecida

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

Parâmetros

request
SignOutRequest

Retornos

Promise<void>