Office.Auth interface
Der Office Auth-Namespace stellt Methoden für die Office-Clientanwendung bereit, Office.authum Zugriffstoken für die Webanwendung des Add-Ins abzurufen. Dadurch kann das Add-In indirekt auch auf die Microsoft Graph-Daten des angemeldeten Benutzers zugreifen, ohne dass sich der Benutzer ein zweites Mal anmelden muss.
Hinweise
Beispiele
// Get the auth context object and use it to get an
// access token.
const authContext = Office.context.auth;
authContext.getAccessTokenAsync(function(result) {
if (result.status === Office.AsyncResultStatus.Succeeded) {
const token = result.value;
console.log(token);
} else {
console.log("Error obtaining token", result.error);
}
});
Methoden
| get |
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. |
| get |
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. Wichtig: In Outlook wird diese API nicht unterstützt, wenn das Add-In in ein Outlook.com- oder Gmail-Postfach geladen wird.
Warnung: |
| get |
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. Wichtig: In Outlook wird diese API nicht unterstützt, wenn das Add-In in ein Outlook.com- oder Gmail-Postfach geladen wird.
Warnung: |
| get |
Ruft Informationen zum angemeldeten Benutzer ab. Das Add-In kann diese Informationen an die Microsoft-Authentifizierungsbibliothek (MSAL.js) übergeben, um ein Zugriffstoken für die aktuelle Sitzung abzurufen. |
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
- Office.AuthOptions
Optional. Akzeptiert ein AuthOptions -Objekt zum Definieren von Anmeldeverhalten.
Gibt zurück
Promise<string>
Zusage an 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 Nachverfolgungsschutz verwenden. Dies führt zu Fehler 13001 ("Der Benutzer ist nicht bei Office angemeldet").
Wenn Sie in Outlook im Web und dem neuen Outlook unter Windows die displayDialogAsync-Methode zum Öffnen eines Dialogfelds verwenden, müssen Sie das Dialogfeld schließen, bevor Sie aufrufen
getAccessTokenkönnen.In einem ereignisbasierten Outlook-Aktivierungs-Add-In wird diese API in Outlook unter Windows ab Version 2111 (Build 14701.20000) unterstützt. Verwenden Sie zum Abrufen eines Zugriffstokens in älteren Builds 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 accessToken = await Office.auth.getAccessToken({
allowSignInPrompt: true,
allowConsentPrompt: true,
forMSGraphAccess: true,
});
} catch (error) {
console.log("Error obtaining token", error);
}
getAccessTokenAsync(options, callback)
Warnung
Diese API ist nun veraltet.
Use Office.auth.getAccessToken instead.
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.
Wichtig: In Outlook wird diese API nicht unterstützt, wenn das Add-In in ein Outlook.com- oder Gmail-Postfach geladen wird.
Warnung: getAccessTokenAsync ist veraltet. Verwenden Sie Office.auth.getAccessToken stattdessen .
getAccessTokenAsync(options?: AuthOptions, callback?: (result: AsyncResult<string>) => void): void;Parameter
- options
- Office.AuthOptions
Optional. Akzeptiert ein AuthOptions -Objekt zum Definieren von Anmeldeverhalten.
- callback
-
(result: Office.AsyncResult<string>) => void
Optional. Akzeptiert eine Rückruffunktion, die das Token für die Benutzer-ID analysieren oder das Token im Fluss "im Auftrag von" verwenden kann, um Zugriff auf Microsoft Graph zu erhalten. Wenn AsyncResult.status "succeeded" ist, AsyncResult.value ist das unformatierte AAD v. 2.0-formatierte Zugriffstoken.
Gibt zurück
void
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.context.auth.getAccessTokenAsync(function(result) {
if (result.status === Office.AsyncResultStatus.Succeeded) {
const token = result.value;
// ...
} else {
console.log("Error obtaining token", result.error);
}
});
getAccessTokenAsync(callback)
Warnung
Diese API ist nun veraltet.
Use Office.auth.getAccessToken instead.
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.
Wichtig: In Outlook wird diese API nicht unterstützt, wenn das Add-In in ein Outlook.com- oder Gmail-Postfach geladen wird.
Warnung: getAccessTokenAsync ist veraltet. Verwenden Sie Office.auth.getAccessToken stattdessen .
getAccessTokenAsync(callback?: (result: AsyncResult<string>) => void): void;Parameter
- callback
-
(result: Office.AsyncResult<string>) => void
Optional. Akzeptiert eine Rückruffunktion, die das Token für die Benutzer-ID analysieren oder das Token im Fluss "im Auftrag von" verwenden kann, um Zugriff auf Microsoft Graph zu erhalten. Wenn AsyncResult.status "succeeded" ist, AsyncResult.value ist das unformatierte AAD v. 2.0-formatierte Zugriffstoken.
Gibt zurück
void
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.
getAuthContext()
Ruft Informationen zum angemeldeten Benutzer ab. Das Add-In kann diese Informationen an die Microsoft-Authentifizierungsbibliothek (MSAL.js) übergeben, um ein Zugriffstoken für die aktuelle Sitzung abzurufen.
getAuthContext(): Promise<AuthContext>;Gibt zurück
Promise<Office.AuthContext>
Zusage an 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);
}
Office Add-ins