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 die Codebeispiele in der gesamten Dokumentation Office.auth.

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 die Identifizierung von Benutzern. Serverseitiger Code kann dieses Token verwenden, um auf Microsoft Graph für die Webanwendung des Add-Ins mithilfe des OAuth-Flusses "im Auftrag von" zuzugreifen.. 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.

Wichtig: In Outlook wird diese API nicht unterstützt, wenn das Add-In in einem Outlook.com- oder Gmail-Postfach geladen wird.

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 die Identifizierung von Benutzern. Serverseitiger Code kann dieses Token verwenden, um auf Microsoft Graph für die Webanwendung des Add-Ins mithilfe des OAuth-Flusses "im Auftrag von" zuzugreifen.. 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.

Wichtig: In Outlook wird diese API nicht unterstützt, wenn das Add-In in einem Outlook.com- oder Gmail-Postfach geladen wird.

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

Parameter

options
OfficeRuntime.AuthOptions

Optional. Akzeptiert ein Objekt zum Definieren des AuthOptions Anmeldeverhaltens.

Gibt zurück

Promise<string>

Zusage für das Zugriffstoken.

Hinweise

Hosts: Excel, Outlook, PowerPoint, Word