Office.Auth interface

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 d’Office se connectent avec des comptes d’organisation 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

Retours

Promesse au jeton d’accès.

Remarques

Applications : Excel, OneNote, 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 Firefox avec la protection renforcée contre le tracking activée. Cela entraîne l’erreur 13001 (« L’utilisateur n’est pas connecté à Office »).

• Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, 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.

• Dans un complément d’activation basée sur un événement Outlook, cette API est prise en charge dans Outlook sur Windows à partir de la version 2111 (build 14701.20000). Pour récupérer un jeton d’accès dans les builds antérieures, utilisez plutôt OfficeRuntime.auth.getAccessToken . Pour plus d’informations, consultez Activer l’authentification unique (SSO) dans les compléments Outlook qui utilisent l’activation en fonction des événements.

Exemples

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);
}

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 ».

Important : dans Outlook, cette API n’est pas prise en charge si le complément est chargé dans une boîte aux lettres Outlook.com ou Gmail.

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

Paramètres

Retours

Remarques

Applications : Excel, OneNote, Outlook, PowerPoint, Word

Jeu de conditions préalables : IdentityAPI 1.3

Cette API nécessite une configuration à authentification unique qui relie le complément à une application Azure. Les utilisateurs d’Office se connectent avec des comptes d’organisation 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.

Exemples

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

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 ».

Important : dans Outlook, cette API n’est pas prise en charge si le complément est chargé dans une boîte aux lettres Outlook.com ou Gmail.

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

Paramètres

Retours

Remarques

Applications : Excel, OneNote, Outlook, PowerPoint, Word

Jeu de conditions préalables : IdentityAPI 1.3

Cette API nécessite une configuration à authentification unique qui relie le complément à une application Azure. Les utilisateurs d’Office se connectent avec des comptes d’organisation 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.

Obtient des informations sur l’utilisateur connecté. Le complément peut transmettre ces informations à la bibliothèque d’authentification Microsoft (MSAL.js) pour obtenir un jeton d’accès pour la session active.

getAuthContext(): Promise<AuthContext>;

Retours

à l’objet AuthContext.

Remarques

Hôtes : Excel, OneNote, Outlook, PowerPoint, Word

Jeu de conditions requises : NestedAppAuth 1.1

Exemples

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