ClientCertificateCredential class
Ermöglicht die Authentifizierung der Microsoft Entra ID mittels eines PEM-codierten Zertifikats, das einer App-Registrierung zugewiesen ist. Weitere Informationen zum Konfigurieren der Zertifikatauthentifizierung finden Sie hier:
Konstruktoren
| Client |
Erstellt eine Instanz des ClientCertificateCredential mit den erforderlichen Angaben zur Authentifizierung gegen die Microsoft Entra ID mit einem Zertifikat. |
| Client |
Erstellt eine Instanz des ClientCertificateCredential mit den erforderlichen Angaben zur Authentifizierung gegen die Microsoft Entra ID mit einem Zertifikat. |
| Client |
Erstellt eine Instanz des ClientCertificateCredential mit den erforderlichen Angaben zur Authentifizierung gegen die Microsoft Entra ID mit einem Zertifikat. |
Methoden
| get |
Authentifiziert sich mit der Microsoft Entra ID und gibt bei Erfolg ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst. |
Details zum Konstruktor
ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)
Erstellt eine Instanz des ClientCertificateCredential mit den erforderlichen Angaben zur Authentifizierung gegen die Microsoft Entra ID mit einem Zertifikat.
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)
Parameter
- tenantId
-
string
Die Microsoft Entra-Tenant-ID (Verzeichnis).
- clientId
-
string
Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.
- configuration
- ClientCertificatePEMCertificate
Andere parameter erforderlich, einschließlich des PEM-codierten Zertifikats als Zeichenfolge. Wenn der Typ ignoriert wird, wird der Wert des PEM-codierten Zertifikats ausgelöst.
Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)
Erstellt eine Instanz des ClientCertificateCredential mit den erforderlichen Angaben zur Authentifizierung gegen die Microsoft Entra ID mit einem Zertifikat.
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)
Parameter
- tenantId
-
string
Die Microsoft Entra-Tenant-ID (Verzeichnis).
- clientId
-
string
Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.
- configuration
- ClientCertificatePEMCertificatePath
Andere parameter erforderlich, einschließlich des Pfads des Zertifikats im Dateisystem. Wenn der Typ ignoriert wird, wird der Wert des Pfads zu einem PEM-Zertifikat ausgelöst.
Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)
Erstellt eine Instanz des ClientCertificateCredential mit den erforderlichen Angaben zur Authentifizierung gegen die Microsoft Entra ID mit einem Zertifikat.
new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)
Parameter
- tenantId
-
string
Die Microsoft Entra-Tenant-ID (Verzeichnis).
- clientId
-
string
Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.
- certificatePath
-
string
Der Pfad zu einem PEM-codierten öffentlichen/privaten Schlüsselzertifikat im Dateisystem. Stellen Sie sicher, dass das Zertifikat im PEM-Format vorliegt und sowohl den öffentlichen als auch den privaten Schlüssel enthält.
Optionen zum Konfigurieren des Clients, der die Authentifizierungsanforderung vorgibt.
Details zur Methode
getToken(string | string[], GetTokenOptions)
Authentifiziert sich mit der Microsoft Entra ID und gibt bei Erfolg ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Parameter
- scopes
-
string | string[]
Die Liste der Bereiche, für die das Token Zugriff hat.
- options
- GetTokenOptions
Die Optionen zum Konfigurieren von Anforderungen, die diese TokenCredential-Implementierung möglicherweise vorgibt.
Gibt zurück
Promise<AccessToken>