Partilhar via


UsernamePasswordCredential class

Permite que a autenticação Microsoft Entra ID com o nome de utilizador e a palavra-passe de um utilizador. Esta credencial requer um elevado grau de confiança, pelo que só deve utilizá-la quando outros tipos de credenciais mais seguros não puderem ser utilizados.

Construtores

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

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

Métodos

getToken(string | string[], GetTokenOptions)

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

Se o utilizador tiver fornecido a opção disableAutomaticAuthentication, uma vez que o token não possa ser obtido automaticamente, este método não tentará pedir a interação do utilizador para obter o token.

Detalhes do Construtor

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

Cria uma instância do UsernamePasswordCredential com os detalhes necessários para se autenticar em 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 de cliente (aplicação) de um Registo de Aplicações no inquilino.

username

string

O endereço de e-mail (nome de utilizador) da conta de utilizador.

password

string

Palavra-passe da conta de utilizador

options
UsernamePasswordCredentialOptions

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

Detalhes de Método

getToken(string | string[], GetTokenOptions)

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

Se o utilizador tiver fornecido a opção disableAutomaticAuthentication, uma vez que o token não possa ser obtido automaticamente, este método não tentará pedir a interação do utilizador para obter o token.

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

Parâmetros

scopes

string | string[]

A lista de âmbitos aos quais o token terá acesso.

options
GetTokenOptions

As opções utilizadas para configurar quaisquer pedidos que esta implementação TokenCredential possa fazer.

Devoluções

Promise<AccessToken>