ClientCertificateCredential class

Pacote:

@azure/identity

Permite que a autenticação Microsoft Entra ID usando um certificado codificado em PEM atribuído a um Registro de Aplicativo. Mais informações sobre como configurar a autenticação de certificado podem ser encontradas aqui:

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Construtores

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Cria uma instância do ClientCertificateCredential com os detalhes necessários para autenticar em Microsoft Entra ID com um certificado.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Cria uma instância do ClientCertificateCredential com os detalhes necessários para autenticar em Microsoft Entra ID com um certificado.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Cria uma instância do ClientCertificateCredential com os detalhes necessários para autenticar em Microsoft Entra ID com um certificado.

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e retorna um token de acesso se tiver êxito. Se a autenticação falhar, um CredentialUnavailableError será lançado com os detalhes da falha.

Detalhes do construtor

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Cria uma instância do ClientCertificateCredential com os detalhes necessários para autenticar em Microsoft Entra ID com um certificado.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)

Parâmetros

tenantId

string

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

clientId

string

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

configuration

ClientCertificatePEMCertificate

Outros parâmetros necessários, incluindo o certificado codificado em PEM como uma cadeia de caracteres. Se o tipo for ignorado, lançaremos o valor do certificado codificado em PEM.

options

ClientCertificateCredentialOptions

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

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Cria uma instância do ClientCertificateCredential com os detalhes necessários para autenticar em Microsoft Entra ID com um certificado.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

Parâmetros

tenantId

string

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

clientId

string

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

configuration

ClientCertificatePEMCertificatePath

Outros parâmetros necessários, incluindo o caminho do certificado no sistema de arquivos. Se o tipo for ignorado, lançaremos o valor do caminho para um certificado PEM.

options

ClientCertificateCredentialOptions

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

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Cria uma instância do ClientCertificateCredential com os detalhes necessários para autenticar em Microsoft Entra ID com um certificado.

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

Parâmetros

tenantId

string

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

clientId

string

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

certificatePath

string

O caminho para um certificado de chave pública/privada codificado em PEM no sistema de arquivos.

options

ClientCertificateCredentialOptions

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

Detalhes do método

getToken(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e retorna um token de acesso se tiver êxito. Se a autenticação falhar, um CredentialUnavailableError será lançado 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 quaisquer solicitações que essa implementação de TokenCredential possa fazer.

Retornos

Promise<AccessToken>