Office.Auth interface

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 zuzugreifen, indem der OAuth-Flow "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

Gibt zurück

Versprechen für das Zugriffstoken.

Hinweise

Anwendungen: Excel, OneNote, Outlook, PowerPoint, Word

Anforderungssatz: IdentityAPI 1.3

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 Firefox mit aktiviertem erweiterten Tracking-Schutz verwenden. Dies führt zu Fehler 13001 ("Der Benutzer ist nicht bei Office angemeldet").

• Wenn Sie in Outlook im Web und im neuen Outlook unter Windows die displayDialogAsync-Methode verwenden, um ein Dialogfeld zu öffnen, müssen Sie das Dialogfeld schließen, bevor Sie aufrufen könnengetAccessToken.

• In einem ereignisbasierten Aktivierungs-Add-In von Outlook wird diese API in Outlook auf Windows ab Version 2111 (Build 14701.20000) unterstützt. Um ein Zugriffstoken in älteren Builds abzurufen, verwenden Sie stattdessen OfficeRuntime.auth.getAccessToken . Weitere Informationen finden Sie unter Aktivieren des einmaligen Anmeldens (Single Sign-On, SSO) in Outlook-Add-Ins, die die ereignisbasierte Aktivierung verwenden.

Beispiele

try{
    const auth = Office.auth;
    const accessToken = await auth.getAccessToken({
        allowSignInPrompt: true,
        allowConsentPrompt: true,
        forMSGraphAccess: true,
    });
    // Use the token to make an API call.
} catch (error) {
    console.log("Error obtaining token", error);
}

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 zuzugreifen, indem der OAuth-Flow "im Auftrag von" verwendet wird.

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

getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

Anwendungen: Excel, OneNote, Outlook, PowerPoint, Word

Anforderungssatz: IdentityAPI 1.3

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.

Beispiele

Office.auth.getAccessTokenAsync(function(result) {
    if (result.status === Office.AsyncResultStatus.Succeeded) {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

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 zuzugreifen, indem der OAuth-Flow "im Auftrag von" verwendet wird.

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

getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;

Parameter

Gibt zurück

Hinweise

Anwendungen: Excel, OneNote, Outlook, PowerPoint, Word

Anforderungssatz: IdentityAPI 1.3

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.

Ruft Informationen zum angemeldeten Benutzer ab. Das Add-In kann diese Informationen an die Microsoft Authentication Library (MSAL.js) übergeben, um ein Zugriffstoken für die aktuelle Sitzung zu erhalten.

getAuthContext(): Promise<AuthContext>;

Gibt zurück

Promise für das AuthContext-Objekt.

Hinweise

Hosts: Excel, OneNote, Outlook, PowerPoint, Word

Anforderungssatz: NestedAppAuth 1.1

Beispiele

try{
    const authContext = await Office.auth.getAuthContext();
    console.log(authContext.userPrincipalName);
} catch (error) {
    console.log("Error obtaining token", error);
}