Partager via

AadTokenProvider class

  • Référence
Paquet:
@microsoft/sp-http-base

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

Cette classe est marquée comme @sealed. Les sous-classes ne doivent pas l’étendre.

Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la AadTokenProvider classe.

Méthodes

getToken(resourceEndpoint, options)

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.
getToken(resourceEndpoint, useCachedToken)

Événements

onBeforeRedirectEvent

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

Avertit le développeur si le flux logique souhaite demander un flux contextuel pour l’interaction utilisateur.
tokenAcquisitionEvent

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

Détails de la méthode

getToken(resourceEndpoint, options)

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.

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

Paramètres

resourceEndpoint

string

ressource pour laquelle le jeton doit être obtenu

options
IGetTokenOptions

Retours

Promise<string>

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

getToken(resourceEndpoint, useCachedToken) 

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

Paramètres

resourceEndpoint

string

useCachedToken

boolean

Retours

Promise<string>

Détails de l'événement

onBeforeRedirectEvent

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

readonly onBeforeRedirectEvent: SPEvent<BeforeRedirectEventArgs>;

Type d'événement

SPEvent<BeforeRedirectEventArgs>

popupEvent

Avertit le développeur si le flux logique souhaite demander un flux contextuel pour l’interaction utilisateur.

readonly popupEvent: SPEvent<PopupEventArgs>;

Type d'événement

SPEvent<PopupEventArgs>

tokenAcquisitionEvent

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

get tokenAcquisitionEvent(): SPEvent<TokenAcquisitionEventArgs>;

Type d'événement

SPEvent<TokenAcquisitionEventArgs>