OfficeRuntime.Auth interface

Paquet:
office-runtime

Avertissement

Cette API est à présent déconseillée.

Use the Office.Auth interface instead.

Interface qui contient les API liées à l’autorisation.

Remarques

Les méthodes de cette interface sont équivalentes à celles de l’interface Office.auth. Si de nouveaux types d’authentification sont ajoutés à l’avenir, ils seront uniquement ajoutés à l’interface Office.auth . Pour des raisons de simplicité, les exemples de code dans la documentation utilisent Office.auth.

Exemples

// Get the auth context object and use it to get an
// access token.
const auth = OfficeRuntime.auth;
const accessToken = await auth.getAccessToken();

Méthodes

getAccessToken(options)

Appelle le point de terminaison Azure Active Directory V 2.0 pour obtenir un jeton d’accès à l’application web de votre complément. Active les compléments pour identifier les utilisateurs. Le code côté serveur peut utiliser ce jeton pour accéder à Microsoft Graph pour l’application web du complément à l’aide du flux OAuth « de la part de ». Cette API nécessite une configuration à authentification unique qui relie le complément à une application Azure. Les utilisateurs Office se connectent à des comptes professionnels et des comptes Microsoft. Microsoft Azure renvoie des jetons destinés aux deux types de comptes utilisateur afin d’accéder aux ressources dans Microsoft Graph.

Détails de la méthode

getAccessToken(options)

Appelle le point de terminaison Azure Active Directory V 2.0 pour obtenir un jeton d’accès à l’application web de votre complément. Active les compléments pour identifier les utilisateurs. Le code côté serveur peut utiliser ce jeton pour accéder à Microsoft Graph pour l’application web du complément à l’aide du flux OAuth « de la part de ». Cette API nécessite une configuration à authentification unique qui relie le complément à une application Azure. Les utilisateurs Office se connectent à des comptes professionnels et des comptes Microsoft. Microsoft Azure renvoie des jetons destinés aux deux types de comptes utilisateur afin d’accéder aux ressources dans Microsoft Graph.

getAccessToken(options?: AuthOptions): Promise<string>;

Paramètres

options
OfficeRuntime.AuthOptions

Facultatif. Accepte un objet pour définir les AuthOptions comportements d’authentification.

Retours

Promise<string>

Promesse au jeton d’accès.

Remarques

Applications : Excel, Outlook, PowerPoint, Word

Jeu de conditions préalables : IdentityAPI 1.3

Important:

  • Dans Outlook, cette API n’est pas prise en charge si vous chargez un complément dans une boîte aux lettres Outlook.com ou Gmail.

  • Dans Outlook sur le web, cette API n’est pas prise en charge si vous utilisez le navigateur Safari. Cela entraîne l’erreur 13001 (« L’utilisateur n’est pas connecté à Office »).

  • Dans Outlook sur le web, si vous utilisez la méthode displayDialogAsync pour ouvrir une boîte de dialogue, vous devez fermer la boîte de dialogue avant de pouvoir appeler getAccessToken.

Exemples

async function getUserData() {
  try {
      const auth = OfficeRuntime.auth;
      let userTokenEncoded = await auth.getAccessToken();
      let userToken = jwt_decode(userTokenEncoded); // Using the https://www.npmjs.com/package/jwt-decode library.
      console.log(userToken.name); // user name
      console.log(userToken.preferred_username); // email
      console.log(userToken.oid); // user id     
  }
  catch (exception) {
      if (exception.code === 13003) {
          // SSO is not supported for domain user accounts, only
          // Microsoft 365 Education or work account, or a Microsoft account.
      } else {
          // Handle error
      }
  }
}