ClientCertificateCredential class

Pakket:: @azure/identity

Maakt authenticatie mogelijk voor Microsoft Entra ID met behulp van een PEM-gecodeerd certificaat dat is toegewezen aan een App-registratie. Meer informatie over het configureren van certificaatverificatie vindt u hier:

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

Constructors

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Maakt een instantie van het ClientCertificateCredential aan met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een certificaat.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Maakt een instantie van het ClientCertificateCredential aan met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een certificaat.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Maakt een instantie van het ClientCertificateCredential aan met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een certificaat.

Methoden

getToken(string | string[], GetTokenOptions)

Authenticeert met Microsoft Entra ID en geeft een toegangstoken terug als het lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout.

Constructordetails

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Maakt een instantie van het ClientCertificateCredential aan met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een certificaat.

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

Parameters

tenantId: string

De Microsoft Entra tenant (directory) ID.

clientId: string

De client-id (toepassing) van een app-registratie in de tenant.

configuration: ClientCertificatePEMCertificate

Andere vereiste parameters, waaronder het PEM-gecodeerde certificaat als een tekenreeks. Als het type wordt genegeerd, wordt de waarde van het PEM-gecodeerde certificaat gegenereerd.

options: ClientCertificateCredentialOptions

Opties voor het configureren van de client die de verificatieaanvraag doet.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Maakt een instantie van het ClientCertificateCredential aan met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een certificaat.

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

Parameters

tenantId: string

De Microsoft Entra tenant (directory) ID.

clientId: string

De client-id (toepassing) van een app-registratie in de tenant.

configuration: ClientCertificatePEMCertificatePath

Andere vereiste parameters, inclusief het pad van het certificaat op het bestandssysteem. Als het type wordt genegeerd, wordt de waarde van het pad naar een PEM-certificaat gegenereerd.

options: ClientCertificateCredentialOptions

Opties voor het configureren van de client die de verificatieaanvraag doet.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Maakt een instantie van het ClientCertificateCredential aan met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een certificaat.

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

Parameters

tenantId: string

De Microsoft Entra tenant (directory) ID.

clientId: string

De client-id (toepassing) van een app-registratie in de tenant.

certificatePath: string

Het pad naar een met PEM gecodeerd openbaar/persoonlijk sleutelcertificaat op het bestandssysteem. Zorg ervoor dat het certificaat de PEM-indeling heeft en zowel de openbare als de persoonlijke sleutel bevat.

options: ClientCertificateCredentialOptions

Opties voor het configureren van de client die de verificatieaanvraag doet.

Methodedetails

getToken(string | string[], GetTokenOptions)

Authenticeert met Microsoft Entra ID en geeft een toegangstoken terug als het lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout.

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

Parameters

scopes: string | string[]

De lijst met bereiken waartoe het token toegang heeft.

options: GetTokenOptions

De opties die worden gebruikt voor het configureren van aanvragen die deze TokenCredential-implementatie mogelijk maakt.

Retouren

Promise<AccessToken>