ClientApplication class
Classe base de resumo para todas as ClienteAplicações - pública e confidencial
Métodos
| acquire |
Adquire um token trocando o Código de Autorização recebido na primeira etapa do fluxo de Código de Autorização OAuth2.0.
|
| acquire |
Adquire um token trocando o token de atualização fornecido por um novo conjunto de tokens. Esta API é fornecida apenas para cenários em que gostaria de migrar de ADAL para MSAL. Caso contrário, recomenda-se usar |
| acquire |
Adquire tokens com concessão de palavra-passe trocando o nome de utilizador e a palavra-passe da aplicação cliente por credenciais A mais recente Prática Atual de Segurança OAuth 2.0 rejeita completamente a concessão de palavra-passe. Mais detalhes sobre esta recomendação na https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 documentação e recomendações da Microsoft encontram-se em:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword |
| acquire |
Adquire um token silenciosamente quando um utilizador especifica a conta para a qual o token é solicitado. Esta API espera que o utilizador forneça um objeto de conta e consulta a cache para recuperar o token, caso exista.
Existe também um booleano opcional "forceRefresh" que o utilizador pode enviar para contornar a cache durante access_token e id_token.
Caso o refresh_token expire ou não seja encontrado, é lançado um erro e a orientação é que o utilizador chame qualquer API interativa de aquisição de tokens (por exemplo: |
| clear |
Limpar o cache |
| get |
Cria o URL do pedido de autorização, permitindo ao utilizador inserir credenciais e consentimento para a aplicação. A URL direciona-se para o endpoint /authorize da autoridade configurada no objeto de aplicação. Assim que o utilizador introduz as suas credenciais e consente, a autoridade enviará uma resposta ao URI de redirecionamento enviado no pedido e deverá conter um código de autorização, que poderá então ser usado para adquirir tokens via |
| get |
Devolve a instância do logger |
| get |
Obtém o token cache da aplicação. |
| set |
Substitui o conjunto de logger predefinido em configurações por um novo Logger por novas configurações |
Detalhes de Método
acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)
Adquire um token trocando o Código de Autorização recebido na primeira etapa do fluxo de Código de Autorização OAuth2.0.
getAuthCodeUrl(AuthorizationCodeUrlRequest) pode ser usado para criar a URL para o primeiro passo do fluxo de Código de Autorização OAuth2.0. Certifique-se de que os valores para redirectUri e os escopos em AuthorizationCodeUrlRequest e AuthorizationCodeRequest são os mesmos.
function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>
Parâmetros
- request
- AuthorizationCodeRequest
- authCodePayLoad
- AuthorizationCodePayload
Devoluções
Promise<AuthenticationResult>
acquireTokenByRefreshToken(RefreshTokenRequest)
Adquire um token trocando o token de atualização fornecido por um novo conjunto de tokens.
Esta API é fornecida apenas para cenários em que gostaria de migrar de ADAL para MSAL. Caso contrário, recomenda-se usar acquireTokenSilent() para cenários silenciosos. Ao usar acquireTokenSilent(), o MSAL gerirá automaticamente a cache e a atualização dos tokens.
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
Parâmetros
- request
- RefreshTokenRequest
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
A mais recente Prática Atual de Segurança OAuth 2.0 rejeita completamente a concessão de palavra-passe. Mais detalhes sobre esta recomendação na https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 documentação e recomendações da Microsoft encontram-se em:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
Parâmetros
- request
- UsernamePasswordRequest
UsernamePasswordRequest
Devoluções
Promise<null | AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
Adquire um token silenciosamente quando um utilizador especifica a conta para a qual o token é solicitado.
Esta API espera que o utilizador forneça um objeto de conta e consulta a cache para recuperar o token, caso exista.
Existe também um booleano opcional "forceRefresh" que o utilizador pode enviar para contornar a cache durante access_token e id_token.
Caso o refresh_token expire ou não seja encontrado, é lançado um erro e a orientação é que o utilizador chame qualquer API interativa de aquisição de tokens (por exemplo: acquireTokenByCode()).
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
Parâmetros
- request
- SilentFlowRequest
Devoluções
Promise<AuthenticationResult>
clearCache()
Limpar o cache
function clearCache()
getAuthCodeUrl(AuthorizationUrlRequest)
Cria o URL do pedido de autorização, permitindo ao utilizador inserir credenciais e consentimento para a aplicação. A URL direciona-se para o endpoint /authorize da autoridade configurada no objeto de aplicação.
Assim que o utilizador introduz as suas credenciais e consente, a autoridade enviará uma resposta ao URI de redirecionamento enviado no pedido e deverá conter um código de autorização, que poderá então ser usado para adquirir tokens via acquireTokenByCode(AuthorizationCodeRequest).
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
Parâmetros
- request
- AuthorizationUrlRequest
Devoluções
Promise<string>
getLogger()
getTokenCache()
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
Instância de logger