Compartilhar via


ClientSecretCredential class

Habilita a autenticação para a ID do Microsoft Entra usando um segredo do cliente que foi gerado para um Registro de Aplicativo. Mais informações sobre como configurar um segredo do cliente podem ser encontradas 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 autenticar na ID do Microsoft Entra com um segredo do cliente.

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado 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 autenticar na ID do Microsoft Entra com um segredo do cliente.

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

Parâmetros

tenantId

string

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

clientId

string

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

clientSecret

string

Um segredo do cliente que foi gerado para o Registro de Aplicativo.

options
ClientSecretCredentialOptions

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

Detalhes do método

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se 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>