ClientAssertionCredential class
Autentica uma entidade de serviço com uma declaração JWT.
Construtores
Client |
Cria uma instância do ClientAssertionCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com uma declaração de cliente fornecida pelo desenvolvedor por meio do parâmetro de função |
Métodos
get |
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
ClientAssertionCredential(string, string, () => Promise<string>, ClientAssertionCredentialOptions)
Cria uma instância do ClientAssertionCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com uma declaração de cliente fornecida pelo desenvolvedor por meio do parâmetro de função getAssertion
.
new ClientAssertionCredential(tenantId: string, clientId: string, getAssertion: () => Promise<string>, options?: ClientAssertionCredentialOptions)
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.
- getAssertion
-
() => Promise<string>
Uma função que recupera a asserção da credencial a ser usada.
- options
- ClientAssertionCredentialOptions
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>