Freigeben über


IAadTokenProvider interface

Diese Klasse ermöglicht es einem Entwickler, OAuth2-Token von Azure AD abzurufen.

OAuth2-Token werden verwendet, um den Benutzer von der SharePoint-Seite bei anderen Diensten wie PowerBI, Sway, Exchange, Yammer usw. zu authentifizieren.

Hinweise

AadTokenProvider ersetzt die /_api. SP. OAuth.Token/Acquire-Endpunkt für die Authentifizierung mit ADAL.js. Wenn Azure AD v2.0 irgendwann die gleichen Szenarien wie die ursprüngliche Version unterstützen kann, werden wir zu MSAL wechseln.

Methoden

getToken(resourceEndpoint, options)

Ruft das AAD OAuth2-Token für eine Ressource ab, wenn der aktuell angemeldete Benutzer Zugriff auf diese Ressource hat.

Das OAuth2-Token SOLLTE nicht vom Aufrufer zwischengespeichert werden, da es bereits von der Methode selbst zwischengespeichert wurde.

Ein Beispiel für einen resourceEndpoint wäre: https://sdfpilot.outlook.com

getToken(resourceEndpoint, useCachedToken)

Ereignisse

onBeforeRedirectEvent

Benachrichtigt den Entwickler, bevor eine vollständige Seitenumleitung erfolgt.

popupEvent

Benachrichtigt den Entwickler, bevor eine vollständige Seitenumleitung erfolgt.

tokenAcquisitionEvent

Benachrichtigt den Entwickler, wenn die Tokenaufforderung eine Benutzeraktion erfordert.

Details zur Methode

getToken(resourceEndpoint, options)

Ruft das AAD OAuth2-Token für eine Ressource ab, wenn der aktuell angemeldete Benutzer Zugriff auf diese Ressource hat.

Das OAuth2-Token SOLLTE nicht vom Aufrufer zwischengespeichert werden, da es bereits von der Methode selbst zwischengespeichert wurde.

Ein Beispiel für einen resourceEndpoint wäre: https://sdfpilot.outlook.com

getToken(resourceEndpoint: string, options?: IGetTokenOptions): Promise<string>;

Parameter

resourceEndpoint

string

Die Ressource, für die das Token abgerufen werden soll

Gibt zurück

Promise<string>

Eine Zusage, die mit dem Token vollständig abgelegt wird oder die mit einer Fehlermeldung abgelehnt wird

getToken(resourceEndpoint, useCachedToken)

getToken(resourceEndpoint: string, useCachedToken?: boolean): Promise<string>;

Parameter

resourceEndpoint

string

useCachedToken

boolean

Gibt zurück

Promise<string>

Details zum Ereignis

onBeforeRedirectEvent

Benachrichtigt den Entwickler, bevor eine vollständige Seitenumleitung erfolgt.

readonly onBeforeRedirectEvent: SPEvent<IBeforeRedirectEventArgs>;

Ereignistyp

popupEvent

Benachrichtigt den Entwickler, bevor eine vollständige Seitenumleitung erfolgt.

readonly popupEvent: SPEvent<IPopupEventArgs>;

Ereignistyp

tokenAcquisitionEvent

Benachrichtigt den Entwickler, wenn die Tokenaufforderung eine Benutzeraktion erfordert.

readonly tokenAcquisitionEvent: SPEvent<ITokenAcquisitionEventArgs>;

Ereignistyp