ClientAssertionCredential class

Autentica uma entidade de serviço com uma declaração JWT.

Construtores

ClientAssertionCredential(string, string, () => Promise<string>, ClientAssertionCredentialOptions)

Cria uma instância do ClientAssertionCredential com os detalhes necessários para autenticar contra Microsoft Entra ID com uma asserção do cliente fornecida pelo desenvolvedor através do parâmetro de função getAssertion.

Métodos

getToken(string | string[], GetTokenOptions)

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

Detalhes do construtor

ClientAssertionCredential(string, string, () => Promise<string>, ClientAssertionCredentialOptions)

Cria uma instância do ClientAssertionCredential com os detalhes necessários para autenticar contra Microsoft Entra ID com uma asserção do cliente fornecida pelo desenvolvedor através do parâmetro de função getAssertion.

new ClientAssertionCredential(tenantId: string, clientId: string, getAssertion: () => Promise<string>, options?: ClientAssertionCredentialOptions)

Parâmetros

tenantId

string

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

clientId

string

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

getAssertion

() => Promise<string>

Uma função que recupera a asserção da credencial a ser usada.

options
ClientAssertionCredentialOptions

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

Detalhes do método

getToken(string | string[], GetTokenOptions)

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

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>