ClientApplication class
Basis-abstrakte Klasse für alle ClientApplications – öffentlich und vertraulich
Methoden
| acquire |
Erwirbt ein Token durch Austauschen des Autorisierungscodes, der aus dem ersten Schritt des OAuth2.0-Autorisierungscodeflusses empfangen wurde.
|
| acquire |
Erwirbt ein Token, indem das für einen neuen Tokensatz bereitgestellte Aktualisierungstoken ausgetauscht wird. Diese API wird nur für Szenarien bereitgestellt, in denen Sie von ADAL zu MSAL migrieren möchten. Andernfalls wird empfohlen, dass Sie für automatische Szenarien verwenden |
| acquire |
Erwirbt Token mit Kennworterteilung durch Austauschen des Benutzernamens und Kennworts von Clientanwendungen für Anmeldeinformationen Die neueste bewährte Methode für OAuth 2.0-Sicherheit verbietet die Kennworterteilung vollständig. Weitere Details zu dieser Empfehlung finden Sie in https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoft Dokumentation und Empfehlungen:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword |
| acquire |
Erwirbt ein Token im Hintergrund, wenn ein Benutzer das Konto angibt, für das das Token angefordert wird. Diese API erwartet, dass der Benutzer ein Kontoobjekt bereitstellt und im Cache sucht, um das Token abzurufen, falls vorhanden.
Es gibt auch einen optionalen Booleschen "forceRefresh", den der Benutzer senden kann, um den Cache für access_token und id_token zu umgehen.
Falls die refresh_token abgelaufen ist oder nicht gefunden wird, wird ein Fehler ausgelöst, und der Benutzer wird aufgefordert, eine interaktive Tokenerwerbs-API aufzurufen (z. B.: |
| clear |
Löschen des Cache |
| get |
Erstellt die URL der Autorisierungsanforderung, sodass der Benutzer Anmeldeinformationen eingeben und der Anwendung zustimmen kann. Die URL zielt auf den /authorize-Endpunkt der Autorität ab, die im Anwendungsobjekt konfiguriert ist. Sobald der Benutzer seine Anmeldeinformationen und Zustimmungen eingibt, sendet die Autorität eine Antwort auf den in der Anforderung gesendeten Umleitungs-URI und sollte einen Autorisierungscode enthalten, der dann zum Abrufen von Token über |
| get |
Gibt die Loggerinstanz zurück. |
| get |
Ruft den Tokencache für die Anwendung ab. |
| set |
Ersetzt den Standardprotokollierer in Konfigurationen durch neuen Logger durch neue Konfigurationen. |
Details zur Methode
acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)
Erwirbt ein Token durch Austauschen des Autorisierungscodes, der aus dem ersten Schritt des OAuth2.0-Autorisierungscodeflusses empfangen wurde.
getAuthCodeUrl(AuthorizationCodeUrlRequest) kann verwendet werden, um die URL für den ersten Schritt des OAuth2.0-Autorisierungscodeflusses zu erstellen. Stellen Sie sicher, dass Werte für redirectUri und Bereiche in AuthorizationCodeUrlRequest und AuthorizationCodeRequest identisch sind.
function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>
Parameter
- request
- AuthorizationCodeRequest
- authCodePayLoad
- AuthorizationCodePayload
Gibt zurück
Promise<AuthenticationResult>
acquireTokenByRefreshToken(RefreshTokenRequest)
Erwirbt ein Token, indem das für einen neuen Tokensatz bereitgestellte Aktualisierungstoken ausgetauscht wird.
Diese API wird nur für Szenarien bereitgestellt, in denen Sie von ADAL zu MSAL migrieren möchten. Andernfalls wird empfohlen, dass Sie für automatische Szenarien verwenden acquireTokenSilent() . Bei Verwendung acquireTokenSilent()behandelt MSAL automatisch das Zwischenspeichern und Aktualisieren von Token.
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
Parameter
- request
- RefreshTokenRequest
Gibt zurück
Promise<null | AuthenticationResult>
acquireTokenByUsernamePassword(UsernamePasswordRequest)
Warnung
Diese API ist nun veraltet.
- Use a more secure flow instead
Erwirbt Token mit Kennworterteilung durch Austauschen des Benutzernamens und Kennworts von Clientanwendungen für Anmeldeinformationen
Die neueste bewährte Methode für OAuth 2.0-Sicherheit verbietet die Kennworterteilung vollständig. Weitere Details zu dieser Empfehlung finden Sie in https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoft Dokumentation und Empfehlungen:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
Parameter
- request
- UsernamePasswordRequest
UsenamePasswordRequest
Gibt zurück
Promise<null | AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
Erwirbt ein Token im Hintergrund, wenn ein Benutzer das Konto angibt, für das das Token angefordert wird.
Diese API erwartet, dass der Benutzer ein Kontoobjekt bereitstellt und im Cache sucht, um das Token abzurufen, falls vorhanden.
Es gibt auch einen optionalen Booleschen "forceRefresh", den der Benutzer senden kann, um den Cache für access_token und id_token zu umgehen.
Falls die refresh_token abgelaufen ist oder nicht gefunden wird, wird ein Fehler ausgelöst, und der Benutzer wird aufgefordert, eine interaktive Tokenerwerbs-API aufzurufen (z. B.: acquireTokenByCode()).
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
Parameter
- request
- SilentFlowRequest
Gibt zurück
Promise<AuthenticationResult>
clearCache()
Löschen des Cache
function clearCache()
getAuthCodeUrl(AuthorizationUrlRequest)
Erstellt die URL der Autorisierungsanforderung, sodass der Benutzer Anmeldeinformationen eingeben und der Anwendung zustimmen kann. Die URL zielt auf den /authorize-Endpunkt der Autorität ab, die im Anwendungsobjekt konfiguriert ist.
Sobald der Benutzer seine Anmeldeinformationen und Zustimmungen eingibt, sendet die Autorität eine Antwort auf den in der Anforderung gesendeten Umleitungs-URI und sollte einen Autorisierungscode enthalten, der dann zum Abrufen von Token über acquireTokenByCode(AuthorizationCodeRequest)verwendet werden kann.
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
Parameter
- request
- AuthorizationUrlRequest
Gibt zurück
Promise<string>
getLogger()
getTokenCache()
Ruft den Tokencache für die Anwendung ab.
function getTokenCache(): TokenCache
Gibt zurück
setLogger(Logger)
Ersetzt den Standardprotokollierer in Konfigurationen durch neuen Logger durch neue Konfigurationen.
function setLogger(logger: Logger)
Parameter
- logger
- Logger
Loggerinstanz