Sdílet prostřednictvím

ClientSecretCredential class

  • Reference
Balíček:
@azure/identity

Umožňuje ověřování Microsoft Entra ID pomocí tajného klíče klienta, který se vygeneroval pro registraci aplikace. Další informace o konfiguraci tajného klíče klienta najdete tady:

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

Konstruktory

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Vytvoří instanci ClientSecretCredential s podrobnostmi potřebnými k ověření Microsoft Entra ID pomocí tajného klíče klienta.

Metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí Microsoft Entra ID a v případě úspěchu vrátí přístupový token. Pokud ověřování selže, vyvolá se chyba CredentialUnavailableError s podrobnostmi o selhání.

Podrobnosti konstruktoru

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Vytvoří instanci ClientSecretCredential s podrobnostmi potřebnými k ověření Microsoft Entra ID pomocí tajného klíče klienta.

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

Parametry

tenantId

string

ID tenanta (adresáře) Microsoft Entra.

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi

clientSecret

string

Tajný klíč klienta, který se vygeneroval pro registraci aplikace.

options
ClientSecretCredentialOptions

Možnosti konfigurace klienta, který vytvoří žádost o ověření.

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí Microsoft Entra ID a v případě úspěchu vrátí přístupový token. Pokud ověřování selže, vyvolá se chyba CredentialUnavailableError s podrobnostmi o selhání.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parametry

scopes

string | string[]

Seznam oborů, ke kterým bude mít token přístup.

options
GetTokenOptions

Možnosti použité ke konfiguraci všech požadavků, které tato implementace TokenCredential může provést.

Návraty

Promise<AccessToken>