ClientCertificateCredential class

Paket:

@azure/identity

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan sertifikat yang dikodekan PEM yang ditetapkan ke Pendaftaran Aplikasi. Informasi selengkapnya tentang cara mengonfigurasi autentikasi sertifikat dapat ditemukan di sini:

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

Konstruktor

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Membuat instans ClientCertificateCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan sertifikat.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Membuat instans ClientCertificateCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan sertifikat.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Membuat instans ClientCertificateCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan sertifikat.

Metode

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan ID Microsoft Entra dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

Detail Konstruktor

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Membuat instans ClientCertificateCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan sertifikat.

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

Parameter

tenantId

string

ID penyewa (direktori) Microsoft Entra.

clientId

string

ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.

configuration

ClientCertificatePEMCertificate

Parameter lain yang diperlukan, termasuk sertifikat yang dikodekan PEM sebagai string. Jika jenis diabaikan, kami akan melemparkan nilai sertifikat yang dikodekan PEM.

options

ClientCertificateCredentialOptions

Opsi untuk mengonfigurasi klien yang membuat permintaan autentikasi.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Membuat instans ClientCertificateCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan sertifikat.

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

Parameter

tenantId

string

ID penyewa (direktori) Microsoft Entra.

clientId

string

ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.

configuration

ClientCertificatePEMCertificatePath

Parameter lain yang diperlukan, termasuk jalur sertifikat pada sistem file. Jika jenis diabaikan, kami akan melemparkan nilai jalur ke sertifikat PEM.

options

ClientCertificateCredentialOptions

Opsi untuk mengonfigurasi klien yang membuat permintaan autentikasi.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Membuat instans ClientCertificateCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan sertifikat.

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

Parameter

tenantId

string

ID penyewa (direktori) Microsoft Entra.

clientId

string

ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.

certificatePath

string

Jalur ke sertifikat kunci publik/privat yang dikodekan PEM pada sistem file. Pastikan sertifikat dalam format PEM dan berisi kunci publik dan privat.

options

ClientCertificateCredentialOptions

Opsi untuk mengonfigurasi klien yang membuat permintaan autentikasi.

Detail Metode

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan ID Microsoft Entra dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

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

Parameter

scopes

string | string[]

Daftar cakupan yang tokennya akan memiliki akses.

options

GetTokenOptions

Opsi yang digunakan untuk mengonfigurasi permintaan apa pun yang mungkin dibuat oleh implementasi TokenCredential ini.

Mengembalikan

Promise<AccessToken>