ClientCertificateCredential class

Pakiet:

@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu certyfikatu zakodowanego za pomocą protokołu PEM przypisanego do rejestracji aplikacji. Więcej informacji na temat konfigurowania uwierzytelniania certyfikatów można znaleźć tutaj:

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)	Tworzy wystąpienie obiektu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu certyfikatu.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Tworzy wystąpienie obiektu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu certyfikatu.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Tworzy wystąpienie obiektu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu certyfikatu.

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Szczegóły konstruktora

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Tworzy wystąpienie obiektu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) Microsoft Entra.

clientId

string

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

configuration

ClientCertificatePEMCertificate

Inne wymagane parametry, w tym certyfikat zakodowany w formacie PEM jako ciąg. Jeśli typ zostanie zignorowany, zwrócimy wartość certyfikatu zakodowanego w standardzie PEM.

options

ClientCertificateCredentialOptions

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

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Tworzy wystąpienie obiektu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) 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 zostanie zignorowany, zwrócimy wartość ścieżki do certyfikatu PEM.

options

ClientCertificateCredentialOptions

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

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Tworzy wystąpienie obiektu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) Microsoft Entra.

clientId

string

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

certificatePath

string

Ścieżka do certyfikatu klucza publicznego/prywatnego zakodowanego w standardzie PEM w systemie plików.

options

ClientCertificateCredentialOptions

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

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

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>