AuthorizationCodeCredential class
Ermöglicht die Authentifizierung zum Microsoft Entra ID mithilfe eines Autorisierungscodes, der über den Autorisierungscodefluss abgerufen wurde, der in der Microsoft Entra ID-Dokumentation ausführlicher beschrieben wird:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Konstruktoren
| Authorization |
Erstellt eine instance von AuthorizationCodeCredential mit den Details, die zum Anfordern eines Zugriffstokens mithilfe einer Authentifizierung erforderlich sind, die von Microsoft Entra ID abgerufen wurde. Derzeit muss der Benutzer dieser Anmeldeinformationen den Autorisierungscodeflow initiieren, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Flow finden Sie hier: |
| Authorization |
Erstellt eine instance von AuthorizationCodeCredential mit den Details, die zum Anfordern eines Zugriffstokens mithilfe einer Authentifizierung erforderlich sind, die von Microsoft Entra ID abgerufen wurde. Derzeit muss der Benutzer dieser Anmeldeinformationen den Autorisierungscodeflow initiieren, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Flow finden Sie hier: |
Methoden
| get |
Authentifiziert sich mit 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 instance von AuthorizationCodeCredential mit den Details, die zum Anfordern eines Zugriffstokens mithilfe einer Authentifizierung erforderlich sind, die von Microsoft Entra ID abgerufen wurde.
Derzeit muss der Benutzer dieser Anmeldeinformationen den Autorisierungscodeflow initiieren, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Flow finden Sie hier:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parameter
- tenantId
-
string
Die Microsoft Entra Mandanten (Verzeichnis)-ID oder -Name. "common" kann bei mehrinstanzenfähigen Szenarien verwendet werden.
- clientId
-
string
Die Client- (Anwendungs-)ID einer App-Registrierung im Mandanten.
- authorizationCode
-
string
Ein Autorisierungscode, der nach dem Autorisierungscodeflow empfangen wurde. Dieser Autorisierungscode darf nicht bereits 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 angibt.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Erstellt eine instance von AuthorizationCodeCredential mit den Details, die zum Anfordern eines Zugriffstokens mithilfe einer Authentifizierung erforderlich sind, die von Microsoft Entra ID abgerufen wurde.
Derzeit muss der Benutzer dieser Anmeldeinformationen den Autorisierungscodeflow initiieren, um einen Autorisierungscode abzurufen, der mit diesen Anmeldeinformationen verwendet werden soll. Ein vollständiges Beispiel für diesen Flow finden Sie hier:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parameter
- tenantId
-
string
Die Microsoft Entra Mandanten (Verzeichnis)-ID oder -Name. "common" kann bei mehrinstanzenfähigen Szenarien verwendet werden.
- clientId
-
string
Die Client- (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 Autorisierungscodeflow empfangen wurde. Dieser Autorisierungscode darf nicht bereits 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 angibt.
Details zur Methode
getToken(string | string[], GetTokenOptions)
Authentifiziert sich mit 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, auf die das Token Zugriff hat.
- options
- GetTokenOptions
Die Optionen, die zum Konfigurieren von Anforderungen verwendet werden, die von dieser TokenCredential-Implementierung möglicherweise vorgenommen werden.
Gibt zurück
Promise<AccessToken>