Partager via

Office.Auth interface

  • Référence
Paquet:
office

L’espace de noms d’authentification Office, Office.auth, fournit des méthodes permettant à l’application cliente Office d’obtenir des jetons d’accès à l’application web du complément. Indirectement, ceci active également le complément pour accéder aux données de Microsoft Graph de l’utilisateur sans que l’utilisateur ne doive se connecter une deuxième fois.

Remarques

Exemples

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

Méthodes

getAccessToken(options)

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. Permet aux compléments d’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 « au nom 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.
getAccessTokenAsync(options, callback)

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. Permet aux compléments d’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 « au nom 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.

Avertissement : getAccessTokenAsync a été déconseillé. Utilisez Office.auth.getAccessToken à la place.
getAccessTokenAsync(callback)

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. Permet aux compléments d’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 « au nom 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.

Avertissement : getAccessTokenAsync a été déconseillé. Utilisez Office.auth.getAccessToken à la place.
getAuthContext()

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.

Détails de la méthode

getAccessToken(options)

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. Permet aux compléments d’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 « au nom 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

options
Office.AuthOptions

Optional. Accepte un AuthOptions objet pour définir des comportements d’authentification.

Retours

Promise<string>

Promesse au jeton d’accès.

Remarques

Applications : Excel, OneNote, Outlook, PowerPoint, Word

Ensemble de conditions requises : 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 améliorée contre le suivi activée. Cela entraîne l’erreur 13001 (« L’utilisateur n’est pas connecté à Office »).

  • Dans Outlook sur le web et 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é sur les événements 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 des builds antérieures, utilisez OfficeRuntime.auth.getAccessToken à la place. Pour plus d’informations, consultez Activer l’authentification unique (SSO) dans les compléments Outlook qui utilisent l’activation basée sur les événements.

Exemples

try{
    const accessToken = await Office.auth.getAccessToken({
        allowSignInPrompt: true,
        allowConsentPrompt: true,
        forMSGraphAccess: true,
    });
} catch (error) {
    console.log("Error obtaining token", error);
}

getAccessTokenAsync(options, callback)

Avertissement

Cette API est à présent déconseillée.

Use Office.auth.getAccessToken instead.

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. Permet aux compléments d’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 « au nom 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.

Avertissement : getAccessTokenAsync a été déconseillé. Utilisez Office.auth.getAccessToken à la place.

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

Paramètres

options
Office.AuthOptions

Optional. Accepte un AuthOptions objet pour définir des comportements d’authentification.

callback

(result: Office.AsyncResult<string>) => void

Optional. Accepte une fonction de rappel qui peut analyser le jeton pour l’ID de l’utilisateur ou utiliser le jeton dans le flux « de la part de » pour obtenir l’accès à Microsoft Graph. Si AsyncResult.status est « réussi », AsyncResult.value est le jeton d’accès brut au format AAD v. 2.0.

Retours

void

Remarques

Applications : Excel, OneNote, Outlook, PowerPoint, Word

Ensemble de conditions requises : 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.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)

Avertissement

Cette API est à présent déconseillée.

Use Office.auth.getAccessToken instead.

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. Permet aux compléments d’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 « au nom 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.

Avertissement : getAccessTokenAsync a été déconseillé. Utilisez Office.auth.getAccessToken à la place.

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

Paramètres

callback

(result: Office.AsyncResult<string>) => void

Optional. Accepte une fonction de rappel qui peut analyser le jeton pour l’ID de l’utilisateur ou utiliser le jeton dans le flux « de la part de » pour obtenir l’accès à Microsoft Graph. Si AsyncResult.status est « réussi », AsyncResult.value est le jeton d’accès brut au format AAD v. 2.0.

Retours

void

Remarques

Applications : Excel, OneNote, Outlook, PowerPoint, Word

Ensemble de conditions requises : 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.

getAuthContext()

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

Promise<Office.AuthContext>

Promesse à l’objet AuthContext.

Remarques

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

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