ClientCertificateCredential class

Paket:: @azure/identity

Möjliggör autentisering till Microsoft Entra ID med ett PEM-kodat certifikat som tilldelas en appregistrering. Mer information om hur du konfigurerar certifikatautentisering finns här:

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

Konstruktorer

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Skapar en instans av ClientCertificateCredential med de uppgifter som behövs för att autentisera mot Microsoft Entra ID med ett certifikat.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Skapar en instans av ClientCertificateCredential med de uppgifter som behövs för att autentisera mot Microsoft Entra ID med ett certifikat.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Skapar en instans av ClientCertificateCredential med de uppgifter som behövs för att autentisera mot Microsoft Entra ID med ett certifikat.

Metoder

getToken(string | string[], GetTokenOptions)

Autentisera med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

Konstruktorinformation

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Skapar en instans av ClientCertificateCredential med de uppgifter som behövs för att autentisera mot Microsoft Entra ID med ett certifikat.

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

Parametrar

tenantId: string

Microsoft Entra-tenantens (katalog) ID.

clientId: string

Klientens (programmets) ID för en appregistrering i klientorganisationen.

configuration: ClientCertificatePEMCertificate

Andra parametrar som krävs, inklusive DET PEM-kodade certifikatet som en sträng. Om typen ignoreras genererar vi värdet för det PEM-kodade certifikatet.

options: ClientCertificateCredentialOptions

Alternativ för att konfigurera klienten som gör autentiseringsbegäran.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Skapar en instans av ClientCertificateCredential med de uppgifter som behövs för att autentisera mot Microsoft Entra ID med ett certifikat.

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

Parametrar

tenantId: string

Microsoft Entra-tenantens (katalog) ID.

clientId: string

Klientens (programmets) ID för en appregistrering i klientorganisationen.

configuration: ClientCertificatePEMCertificatePath

Andra parametrar som krävs, inklusive sökvägen till certifikatet i filsystemet. Om typen ignoreras genererar vi värdet för sökvägen till ett PEM-certifikat.

options: ClientCertificateCredentialOptions

Alternativ för att konfigurera klienten som gör autentiseringsbegäran.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Skapar en instans av ClientCertificateCredential med de uppgifter som behövs för att autentisera mot Microsoft Entra ID med ett certifikat.

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

Parametrar

tenantId: string

Microsoft Entra-tenantens (katalog) ID.

clientId: string

Klientens (programmets) ID för en appregistrering i klientorganisationen.

certificatePath: string

Sökvägen till ett PEM-kodat offentligt/privat nyckelcertifikat i filsystemet. Se till att certifikatet är i PEM-format och innehåller både de offentliga och privata nycklarna.

options: ClientCertificateCredentialOptions

Alternativ för att konfigurera klienten som gör autentiseringsbegäran.

Metodinformation

getToken(string | string[], GetTokenOptions)

Autentisera med Microsoft Entra ID och returnerar en åtkomsttoken om det lyckas. Om autentiseringen misslyckas utlöses en CredentialUnavailableError med information om felet.

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

Parametrar

scopes: string | string[]

Listan över omfång som token ska ha åtkomst till.

options: GetTokenOptions

De alternativ som används för att konfigurera alla begäranden som denna TokenCredential-implementering kan göra.

Returer

Promise<AccessToken>