Freigeben über


AadTokenProvider class

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

Diese Klasse ist als @sealedgekennzeichnet. Unterklassen sollten sie nicht erweitern.

Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse AadTokenProvider erweitern.

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 vom Aufrufer nicht zwischengespeichert werden, da es bereits von der Methode selbst zwischengespeichert wird.

getToken(resourceEndpoint, useCachedToken)

Ereignisse

onBeforeRedirectEvent

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

popupEvent

Benachrichtigt den Entwickler, wenn der Logikflow einen Popupflow für die Benutzerinteraktion anfordern möchte.

tokenAcquisitionEvent

Benachrichtigt den Entwickler, wenn der Tokenerwerb 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 vom Aufrufer nicht zwischengespeichert werden, da es bereits von der Methode selbst zwischengespeichert wird.

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 erfüllt 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<BeforeRedirectEventArgs>;

Ereignistyp

popupEvent

Benachrichtigt den Entwickler, wenn der Logikflow einen Popupflow für die Benutzerinteraktion anfordern möchte.

readonly popupEvent: SPEvent<PopupEventArgs>;

Ereignistyp

tokenAcquisitionEvent

Benachrichtigt den Entwickler, wenn der Tokenerwerb eine Benutzeraktion erfordert.

get tokenAcquisitionEvent(): SPEvent<TokenAcquisitionEventArgs>;

Ereignistyp