Compartilhar via


UsernamePasswordCredential class

Habilita a autenticação para a ID do Microsoft Entra com o nome de usuário e a senha de um usuário. Essa credencial requer um alto grau de confiança, portanto, você só deve usá-la quando outros tipos de credencial 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 na ID do Microsoft Entra com um nome de usuário e senha.

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado com os detalhes da falha.

Se o usuário tiver fornecido a opção disableAutomaticAuthentication, depois que o token não puder ser recuperado silenciosamente, esse método não tentará solicitar 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 na ID do Microsoft Entra com um nome de usuário e senha.

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

Parâmetros

tenantId

string

O locatário do Microsoft Entra (diretório).

clientId

string

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

username

string

O endereço de email da conta de usuário (nome de usuário).

password

string

A senha da conta de usuário

options
UsernamePasswordCredentialOptions

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

Detalhes do método

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado com os detalhes da falha.

Se o usuário tiver fornecido a opção disableAutomaticAuthentication, depois que o token não puder ser recuperado silenciosamente, esse método não tentará solicitar 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 as solicitações que essa implementação do TokenCredential pode fazer.

Retornos

Promise<AccessToken>