Office.Auth interface

Llama al punto de conexión de Azure Active Directory V 2.0 para obtener acceso a un token para la aplicación de web del complemento. Permite que los complementos identifiquen a los usuarios. El código del lado servidor puede usar este token para acceder a Microsoft Graph para la aplicación web del complemento mediante el flujo de OAuth "en nombre de". Esta API requiere una configuración de inicio de sesión único que relacione el complemento con una aplicación de Azure. Los usuarios de Office inician sesión con cuentas de la organización y cuentas de Microsoft. Microsoft Azure devuelve tokens destinados a ambos tipos de cuentas de usuario para tener acceso a recursos en Microsoft Graph.

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

Parámetros

Devoluciones

Prometer el token de acceso.

Comentarios

Aplicaciones: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Importante:

• En Outlook, esta API no es compatible si carga un complemento en un buzón de Outlook.com o Gmail.

• En Outlook en la Web, esta API no es compatible si usa Firefox con Protección de rastreo mejorada activada. Esto da como resultado el error 13001 ("El usuario no ha iniciado sesión en Office").

• En Outlook en la Web y en el nuevo Outlook en Windows, si usa el método displayDialogAsync para abrir un cuadro de diálogo, debe cerrarlo para poder llamar a getAccessToken.

• Esta API se admite en Outlook en Windows como complemento de activación basada en eventos a partir de la versión 2111 (compilación 14701.20000). Para recuperar un token de acceso en compilaciones anteriores, use OfficeRuntime.auth.getAccessToken en su lugar. Para obtener más información, vea Habilitar el inicio de sesión único (SSO) en los complementos de Outlook que usan la activación basada en eventos.

Ejemplos

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

Llama al punto de conexión de Azure Active Directory V 2.0 para obtener acceso a un token para la aplicación de web del complemento. Permite que los complementos identifiquen a los usuarios. El código del lado servidor puede usar este token para acceder a Microsoft Graph para la aplicación web del complemento mediante el flujo de OAuth "en nombre de".

Importante: En Outlook, esta API no es compatible si el complemento se carga en un buzón de Outlook.com o de Gmail.

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

Parámetros

Devoluciones

Comentarios

Aplicaciones: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Esta API requiere una configuración de inicio de sesión único que relacione el complemento con una aplicación de Azure. Los usuarios de Office inician sesión con cuentas de la organización y cuentas de Microsoft. Microsoft Azure devuelve tokens destinados a ambos tipos de cuentas de usuario para tener acceso a recursos en Microsoft Graph.

Ejemplos

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

Llama al punto de conexión de Azure Active Directory V 2.0 para obtener acceso a un token para la aplicación de web del complemento. Permite que los complementos identifiquen a los usuarios. El código del lado servidor puede usar este token para acceder a Microsoft Graph para la aplicación web del complemento mediante el flujo de OAuth "en nombre de".

Importante: En Outlook, esta API no es compatible si el complemento se carga en un buzón de Outlook.com o de Gmail.

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

Parámetros

Devoluciones

Comentarios

Aplicaciones: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Esta API requiere una configuración de inicio de sesión único que relacione el complemento con una aplicación de Azure. Los usuarios de Office inician sesión con cuentas de la organización y cuentas de Microsoft. Microsoft Azure devuelve tokens destinados a ambos tipos de cuentas de usuario para tener acceso a recursos en Microsoft Graph.

Obtiene información sobre el usuario que ha iniciado sesión. El complemento puede pasar esta información a la biblioteca de autenticación de Microsoft (MSAL.js) para obtener un token de acceso para la sesión actual.

getAuthContext(): Promise<AuthContext>;

Devoluciones

Promesa al objeto AuthContext.

Comentarios

Hosts: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: NestedAppAuth 1.1

Ejemplos

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