AuthorizationCodeCredential class
Ermöglicht die Authentifizierung für Microsoft Entra-ID mithilfe eines Autorisierungscodes, der über den Autorisierungscodefluss abgerufen wurde, der in der Dokumentation zur Microsoft Entra-ID ausführlicher beschrieben wird:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Konstruktoren
| Authorization |
Erstellt eine Instanz von AuthorizationCodeCredential mit den Details, die erforderlich sind, um ein Zugriffstoken mithilfe einer Authentifizierung anzufordern, die von der Microsoft Entra-ID abgerufen wurde. Es ist derzeit erforderlich, dass der Benutzer dieser Anmeldeinformationen den Autorisierungscodefluss initiiert, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Fluss finden Sie hier: |
| Authorization |
Erstellt eine Instanz von AuthorizationCodeCredential mit den Details, die erforderlich sind, um ein Zugriffstoken mithilfe einer Authentifizierung anzufordern, die von der Microsoft Entra-ID abgerufen wurde. Es ist derzeit erforderlich, dass der Benutzer dieser Anmeldeinformationen den Autorisierungscodefluss initiiert, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Fluss finden Sie hier: |
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
AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)
Erstellt eine Instanz von AuthorizationCodeCredential mit den Details, die erforderlich sind, um ein Zugriffstoken mithilfe einer Authentifizierung anzufordern, die von der Microsoft Entra-ID abgerufen wurde.
Es ist derzeit erforderlich, dass der Benutzer dieser Anmeldeinformationen den Autorisierungscodefluss initiiert, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Fluss finden Sie hier:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parameter
- tenantId
-
string
Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID) oder der Name. "common" kann beim Umgang mit Szenarien mit mehreren Mandanten verwendet werden.
- clientId
-
string
Die Client-ID (Anwendungs-ID) einer App-Registrierung im Mandanten.
- authorizationCode
-
string
Ein Autorisierungscode, der nach dem Autorisierungscodefluss empfangen wurde. Dieser Autorisierungscode darf noch nicht zum Abrufen eines Zugriffstokens verwendet worden sein.
- redirectUri
-
string
Der Umleitungs-URI, der zum Anfordern des Autorisierungscodes verwendet wurde. Muss derselbe URI sein, der für die App-Registrierung konfiguriert ist.
Optionen zum Konfigurieren des Clients, der die Zugriffstokenanforderung vorgibt.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Erstellt eine Instanz von AuthorizationCodeCredential mit den Details, die erforderlich sind, um ein Zugriffstoken mithilfe einer Authentifizierung anzufordern, die von der Microsoft Entra-ID abgerufen wurde.
Es ist derzeit erforderlich, dass der Benutzer dieser Anmeldeinformationen den Autorisierungscodefluss initiiert, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Fluss finden Sie hier:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parameter
- tenantId
-
string
Die Microsoft Entra-Mandanten-ID (Verzeichnis-ID) oder der Name. "common" kann beim Umgang mit Szenarien mit mehreren Mandanten verwendet werden.
- 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
- authorizationCode
-
string
Ein Autorisierungscode, der nach dem Autorisierungscodefluss empfangen wurde. Dieser Autorisierungscode darf noch nicht zum Abrufen eines Zugriffstokens verwendet worden sein.
- redirectUri
-
string
Der Umleitungs-URI, der zum Anfordern des Autorisierungscodes verwendet wurde. Muss derselbe URI sein, der für die App-Registrierung konfiguriert ist.
Optionen zum Konfigurieren des Clients, der die Zugriffstokenanforderung 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>