ClientCertificateCredential class

Balíček:

@azure/identity

Umožňuje ověřování pro Microsoft Entra ID pomocí certifikátu s kódováním PEM, který je přiřazen k registraci aplikace. Další informace o konfiguraci ověřování certifikátů najdete tady:

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Konstruktory

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Vytvoří instanci ClientCertificateCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí certifikátu.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Vytvoří instanci ClientCertificateCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí certifikátu.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Vytvoří instanci ClientCertificateCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí certifikátu.

Metody

getToken(string | string[], GetTokenOptions)

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

Podrobnosti konstruktoru

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Vytvoří instanci ClientCertificateCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí certifikátu.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)

Parametry

tenantId

string

ID tenanta Microsoft Entra (adresáře).

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

configuration

ClientCertificatePEMCertificate

Další požadované parametry, včetně certifikátu s kódováním PEM jako řetězce. Pokud je typ ignorován, vyvoláme hodnotu certifikátu s kódováním PEM.

options

ClientCertificateCredentialOptions

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

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Vytvoří instanci ClientCertificateCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí certifikátu.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

Parametry

tenantId

string

ID tenanta Microsoft Entra (adresáře).

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

configuration

ClientCertificatePEMCertificatePath

Další požadované parametry, včetně cesty certifikátu v systému souborů. Pokud je typ ignorován, vyvoláme hodnotu cesty k certifikátu PEM.

options

ClientCertificateCredentialOptions

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

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Vytvoří instanci ClientCertificateCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí certifikátu.

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

Parametry

tenantId

string

ID tenanta Microsoft Entra (adresáře).

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

certificatePath

string

Cesta k certifikátu veřejného/privátního klíče s kódováním PEM v systému souborů.

options

ClientCertificateCredentialOptions

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

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

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

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

Parametry

scopes

string | string[]

Seznam oborů, pro které 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>