ClientSecretCredential class
Ermöglicht die Authentifizierung für Microsoft Entra-ID mithilfe eines geheimen Clientschlüssels, der für eine App-Registrierung generiert wurde. Weitere Informationen zum Konfigurieren eines geheimen Clientschlüssels finden Sie hier:
Konstruktoren
| Client |
Erstellt eine Instanz der ClientSecretCredential mit den Details, die für die Authentifizierung bei Microsoft Entra ID mit einem geheimen Clientschlüssel erforderlich sind. |
Methoden
| get |
Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst. |
Details zum Konstruktor
ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)
Erstellt eine Instanz der ClientSecretCredential mit den Details, die für die Authentifizierung bei Microsoft Entra ID mit einem geheimen Clientschlüssel erforderlich sind.
new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)Parameter
- tenantId
-
string
Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID).
- clientId
-
string
Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.
- clientSecret
-
string
Ein geheimer Clientschlüssel, der für die App-Registrierung generiert wurde.
- options
- ClientSecretCredentialOptions
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 erfolgreicher Ausführung 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>