ClientSecretCredential class

Ermöglicht die Authentifizierung der Microsoft Entra ID mithilfe eines Client-Geheimnisses, das für eine App-Registrierung generiert wurde. Weitere Informationen zum Konfigurieren eines geheimen Clientschlüssels finden Sie hier:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Konstruktoren

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Erstellt eine Instanz des ClientSecretCredential mit den Details, die zur Authentifizierung gegen die Microsoft Entra ID mit einem Client-Geheimnis erforderlich sind.

Methoden

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.

Details zum Konstruktor

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Erstellt eine Instanz des ClientSecretCredential mit den Details, die zur Authentifizierung gegen die Microsoft Entra ID mit einem Client-Geheimnis erforderlich sind.

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

Parameter

tenantId

string

Die Microsoft Entra-Tenant-ID (Verzeichnis).

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 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>