OfficeRuntime.Auth interface

  • Referenz
Paket:
office-runtime

Schnittstelle, die autorisierungsbezogene APIs enthält.

Hinweise

Die Methoden in dieser Schnittstelle entsprechen denen in der Office.auth-Schnittstelle. Wenn in Zukunft neue Authentifizierungstypen hinzugefügt werden, werden sie nur der Office.auth Schnittstelle hinzugefügt. Der Einfachheit halber verwenden Office.authdie Codebeispiele in der gesamten Dokumentation .

Beispiele

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

Methoden

getAccessToken(options)

Ruft den Azure Active Directory V 2.0-Endpunkt auf, um ein Zugriffstoken für das Add-In Ihrer Web-Anwendung zu erhalten. Ermöglicht Add-Ins, Benutzer zu identifizieren. Serverseitiger Code kann dieses Token verwenden, um auf Microsoft Graph für die Webanwendung des Add-Ins zuzugreifen, indem der OAuth-Fluss "im Auftrag von" verwendet wird. Diese API erfordert eine Single Sign-On-Konfiguration, die das Add-In mit einer Azure-Anwendung verbindet. Office-Benutzer melden sich mit Organisationskonten und Microsoft-Konten an. Microsoft Azure gibt Token für den Zugriff auf Ressourcen von Microsoft Graph für beide Kontotypen zurück.

Details zur Methode

getAccessToken(options)

Ruft den Azure Active Directory V 2.0-Endpunkt auf, um ein Zugriffstoken für das Add-In Ihrer Web-Anwendung zu erhalten. Ermöglicht Add-Ins, Benutzer zu identifizieren. Serverseitiger Code kann dieses Token verwenden, um auf Microsoft Graph für die Webanwendung des Add-Ins zuzugreifen, indem der OAuth-Fluss "im Auftrag von" verwendet wird. Diese API erfordert eine Single Sign-On-Konfiguration, die das Add-In mit einer Azure-Anwendung verbindet. Office-Benutzer melden sich mit Organisationskonten und Microsoft-Konten an. Microsoft Azure gibt Token für den Zugriff auf Ressourcen von Microsoft Graph für beide Kontotypen zurück.

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

Parameter

options
OfficeRuntime.AuthOptions

Optional. Akzeptiert ein AuthOptions -Objekt zum Definieren von Anmeldeverhalten.

Gibt zurück

Promise<string>

Zusage an das Zugriffstoken.

Hinweise

Anwendungen: Excel, Outlook, PowerPoint, Word

Wichtig:

  • In Outlook wird diese API nicht unterstützt, wenn Sie ein Add-In in ein Outlook.com- oder Gmail-Postfach laden.

  • In Outlook im Web wird diese API nicht unterstützt, wenn Sie den Safari-Browser verwenden. Dies führt zu Fehler 13001 ("Der Benutzer ist nicht bei Office angemeldet").

  • Wenn Sie in Outlook im Web die displayDialogAsync-Methode zum Öffnen eines Dialogfelds verwenden, müssen Sie das Dialogfeld schließen, bevor Sie aufrufen getAccessTokenkönnen.

Beispiele

async function getUserData() {
  try {
      let userTokenEncoded = await OfficeRuntime.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
      }
  }
}