ClientAssertionCredential class

Autentica um principal de serviço com uma afirmação JWT.

Construtores

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

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

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.

Detalhes do Construtor

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

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

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

Parâmetros

tenantId

string

O ID do inquilino Microsoft Entra (diretório).

clientId

string

O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.

getAssertion

() => Promise<string>

Uma função que obtém a asserção da credencial a utilizar.

options
ClientAssertionCredentialOptions

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.

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>