IAadTokenProvider interface

Cette classe permet à un développeur d’obtenir des jetons OAuth2 à partir d’Azure AD.

Les jetons OAuth2 sont utilisés pour authentifier l’utilisateur de la page SharePoint auprès d’autres services tels que PowerBI, Sway, Exchange, Yammer, etc.

Remarques

AadTokenProvider remplace /_api. Sp. Point de terminaison OAuth.Token/Acquire pour l’authentification avec ADAL.js. À un moment donné, quand Azure AD v2.0 peut prendre en charge les mêmes scénarios que la version d’origine, nous basculerons vers MSAL.

Méthodes

getToken(resourceEndpoint, useCachedToken)

Récupère le jeton OAuth2 AAD pour une ressource si l’utilisateur actuellement connecté a accès à cette ressource.

Le jeton OAuth2 NE DOIT PAS être mis en cache par l’appelant, car il est déjà mis en cache par la méthode elle-même.

Un exemple de resourceEndpoint serait https://sdfpilot.outlook.com

Événements

onBeforeRedirectEvent

Avertit le développeur avant qu’une redirection en pleine page ne se produise.

tokenAcquisitionEvent

Avertit le développeur lorsque l’acquisition de jetons nécessite une action de l’utilisateur.

Détails de la méthode

getToken(resourceEndpoint, useCachedToken)

Récupère le jeton OAuth2 AAD pour une ressource si l’utilisateur actuellement connecté a accès à cette ressource.

Le jeton OAuth2 NE DOIT PAS être mis en cache par l’appelant, car il est déjà mis en cache par la méthode elle-même.

Un exemple de resourceEndpoint serait https://sdfpilot.outlook.com

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

Paramètres

resourceEndpoint

string

ressource pour laquelle le jeton doit être obtenu

useCachedToken

boolean

Permet au développeur de spécifier si les jetons mis en cache doivent être retournés.

Retours

Promise<string>

Promesse qui sera remplie avec le jeton ou qui sera rejetée avec un message d’erreur

Détails de l'événement

onBeforeRedirectEvent

Avertit le développeur avant qu’une redirection en pleine page ne se produise.

readonly onBeforeRedirectEvent: SPEvent<IBeforeRedirectEventArgs>;

Type d'événement

tokenAcquisitionEvent

Avertit le développeur lorsque l’acquisition de jetons nécessite une action de l’utilisateur.

readonly tokenAcquisitionEvent: SPEvent<ITokenAcquisitionEventArgs>;

Type d'événement