ClientSecretCredential class
Permite a autenticação do Microsoft Entra ID usando um segredo de cliente gerado para um Registro de Aplicativo. Mais informações sobre como configurar um segredo do cliente podem ser encontradas aqui:
Construtores
| Client |
Cria uma instância do ClientSecretCredential com os detalhes necessários para autenticar contra o Microsoft Entra ID com um cliente secreto. |
Métodos
| get |
Autentica com o Microsoft Entra ID e retorna um token de acesso se for 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 contra o Microsoft Entra ID com um cliente secreto.
new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)Parâmetros
- tenantId
-
string
O ID do locatário (diretório) da Microsoft Entra.
- 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 o Microsoft Entra ID e retorna um token de acesso se for 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>