ClientCertificateCredential class
Permite que a autenticação Microsoft Entra ID através de um certificado codificado por PEM atribuído a um Registo de Aplicações. Pode encontrar mais informações sobre como configurar a autenticação de certificados aqui:
Construtores
| Client |
Cria uma instância do ClientCertificateCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um certificado. |
| Client |
Cria uma instância do ClientCertificateCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um certificado. |
| Client |
Cria uma instância do ClientCertificateCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um certificado. |
Métodos
| get |
Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será apresentado um CredentialUnavailableError 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 se autenticar em Microsoft Entra ID com um certificado.
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)Parâmetros
- tenantId
-
string
O ID de inquilino (diretório) Microsoft Entra.
- clientId
-
string
O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.
- configuration
- ClientCertificatePEMCertificate
São necessários outros parâmetros, incluindo o certificado codificado por PEM como uma cadeia. Se o tipo for ignorado, iremos gerar o valor do certificado codificado por PEM.
Opções para configurar o cliente que faz o pedido de autenticação.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)
Cria uma instância do ClientCertificateCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um certificado.
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)Parâmetros
- tenantId
-
string
O ID de inquilino (diretório) Microsoft Entra.
- clientId
-
string
O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.
- configuration
- ClientCertificatePEMCertificatePath
São necessários outros parâmetros, incluindo o caminho do certificado no sistema de ficheiros. Se o tipo for ignorado, iremos lançar o valor do caminho para um certificado PEM.
Opções para configurar o cliente que faz o pedido de autenticação.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)
Cria uma instância do ClientCertificateCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um certificado.
new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)Parâmetros
- tenantId
-
string
O ID de inquilino (diretório) Microsoft Entra.
- clientId
-
string
O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.
- certificatePath
-
string
O caminho para um certificado de chave pública/privada codificada por PEM no sistema de ficheiros.
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á apresentado 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>