Partilhar via


ClientSecretCredential class

Permite que a autenticação Microsoft Entra ID através de um segredo de cliente que foi gerado para um Registo de Aplicações. Pode encontrar mais informações sobre como configurar um segredo do cliente aqui:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Construtores

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Cria uma instância do ClientSecretCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um segredo do cliente.

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

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Cria uma instância do ClientSecretCredential com os detalhes necessários para se autenticar em Microsoft Entra ID com um segredo do cliente.

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

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.

clientSecret

string

Um segredo do cliente que foi gerado para o Registo de Aplicações.

options
ClientSecretCredentialOptions

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>