ClientCertificateCredential class

Pakiet:

@azure/identity

Umożliwia uwierzytelnianie w usłudze Microsoft Entra ID 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/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Konstruktory

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Tworzy wystąpienie elementu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu certyfikatu.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Tworzy wystąpienie elementu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu certyfikatu.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Tworzy wystąpienie elementu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu certyfikatu.

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Szczegóły konstruktora

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Tworzy wystąpienie elementu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) firmy Microsoft.

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 wystąpienie elementu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) firmy Microsoft.

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 wystąpienie elementu ClientCertificateCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu certyfikatu.

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

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) firmy Microsoft.

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ę przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. 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>