ClientCertificateCredential class

Pakiet:

@azure/identity

Umożliwia uwierzytelnianie do Microsoft Entra ID za pomocą certyfikatu zakodowanego przez PEM, który jest przypisany do rejestracji aplikacji. Więcej informacji na temat konfigurowania uwierzytelniania certyfikatów można znaleźć tutaj:

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

Konstruktory

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Tworzy instancję ClientCertificateCredential z detalami potrzebnymi do uwierzytelnienia na Microsoft Entra ID za pomocą certyfikatu.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Tworzy instancję ClientCertificateCredential z detalami potrzebnymi do uwierzytelnienia na Microsoft Entra ID za pomocą certyfikatu.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Tworzy instancję ClientCertificateCredential z detalami potrzebnymi do uwierzytelnienia na Microsoft Entra ID za pomocą certyfikatu.

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Szczegóły konstruktora

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Tworzy instancję ClientCertificateCredential z detalami potrzebnymi do uwierzytelnienia na Microsoft Entra ID za pomocą certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawcy (katalog) Microsoft Entra.

clientId

string

Identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

configuration

ClientCertificatePEMCertificate

Inne wymagane parametry, w tym certyfikat zakodowany za pomocą standardu PEM jako ciąg. Jeśli typ zostanie zignorowany, zgłosimy wartość certyfikatu zakodowanego w standardzie PEM.

options

ClientCertificateCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie uwierzytelniania.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Tworzy instancję ClientCertificateCredential z detalami potrzebnymi do uwierzytelnienia na Microsoft Entra ID za pomocą certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawcy (katalog) Microsoft Entra.

clientId

string

Identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

configuration

ClientCertificatePEMCertificatePath

Inne wymagane parametry, w tym ścieżka certyfikatu w systemie plików. Jeśli typ jest ignorowany, zgłosimy wartość ścieżki do certyfikatu PEM.

options

ClientCertificateCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie uwierzytelniania.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Tworzy instancję ClientCertificateCredential z detalami potrzebnymi do uwierzytelnienia na Microsoft Entra ID za pomocą certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawcy (katalog) Microsoft Entra.

clientId

string

Identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

certificatePath

string

Ścieżka do certyfikatu klucza publicznego/prywatnego zakodowanego za pomocą standardu PEM w systemie plików. Upewnij się, że certyfikat jest w formacie PEM i zawiera zarówno klucze publiczne, jak i prywatne.

options

ClientCertificateCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie uwierzytelniania.

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options

GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być tworzone przez tę implementację TokenCredential.

Zwraca

Promise<AccessToken>