UsernamePasswordCredential class

Aviso

Esta API foi preterida.

UsernamePasswordCredential is deprecated. Use a more secure credential. See https://aka.ms/azsdk/identity/mfa for details.

Permite a autenticação do Microsoft Entra ID com o nome de utilizador e a palavra-passe do utilizador. Essa credencial requer um alto grau de confiança, portanto, você só deve usá-la quando outros tipos de credenciais mais seguros não puderem ser usados.

Construtores

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

Cria uma instância do UsernamePasswordCredential com os detalhes necessários para autenticar contra o Microsoft Entra ID com um nome de utilizador e palavra-passe.

Métodos

getToken(string | string[], GetTokenOptions)

Autentica-se com o Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, uma CredentialUnavailableError será lançada com os detalhes da falha.

Se o usuário forneceu a opção disableAutomaticAuthentication, uma vez que o token não pode ser recuperado silenciosamente, esse método não tentará solicitar a interação do usuário para recuperar o token.

Detalhes do Construtor

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

Cria uma instância do UsernamePasswordCredential com os detalhes necessários para autenticar contra o Microsoft Entra ID com um nome de utilizador e palavra-passe.

new UsernamePasswordCredential(tenantId: string, clientId: string, username: string, password: string, options?: UsernamePasswordCredentialOptions)

Parâmetros

tenantId

string

O inquilino Microsoft Entra (diretório).

clientId

string

O ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.

username

string

O endereço de e-mail da conta de usuário (nome de usuário).

password

string

A palavra-passe da conta de utilizador

options
UsernamePasswordCredentialOptions

Opções para configurar o cliente que faz a solicitação de autenticação.

Detalhes de Método

getToken(string | string[], GetTokenOptions)

Autentica-se com o Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, uma CredentialUnavailableError será lançada com os detalhes da falha.

Se o usuário forneceu a opção disableAutomaticAuthentication, uma vez que o token não pode ser recuperado silenciosamente, esse método não tentará solicitar a interação do usuário para recuperar o token.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parâmetros

scopes

string | string[]

A lista de escopos para os quais o token terá acesso.

options
GetTokenOptions

As opções usadas para configurar quaisquer solicitações que essa implementação de TokenCredential possa fazer.

Devoluções

Promise<AccessToken>