Office.Auth interface

Chama o ponto de extremidade do Azure Active Directory V 2.0 para obter um token de acesso para o aplicativo Web do seu suplemento. Permite que os suplementos identifiquem usuários. O código do lado do servidor pode usar esse token para acessar o Microsoft Graph para o aplicativo Web do suplemento usando o fluxo OAuth "em nome de". Essa API exige uma configuração de logon única que preencha o suplemento para um aplicativo do Azure. Os usuários do Office entram com Contas Organizacionais e Contas Microsoft. O Microsoft Azure retorna tokens destinados a ambos os tipos de conta de usuário para acessar recursos no Microsoft Graph.

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

Parâmetros

Retornos

promessa ao token de acesso.

Comentários

Aplicativos: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Importante:

• No Outlook, essa API não terá suporte se você carregar um suplemento em uma caixa de correio do Outlook.com ou do Gmail.

• No Outlook na Web, essa API não será compatível se você usar o Firefox com a Proteção Aprimorada contra Rastreamento ativada. Isso resulta no erro 13001 ("O usuário não está conectado ao Office").

• No Outlook na Web e no novo Outlook no Windows, se você usar o método displayDialogAsync para abrir uma caixa de diálogo, deverá fechar a caixa de diálogo antes de chamar getAccessToken.

• Em um suplemento de ativação baseada em eventos do Outlook, essa API tem suporte no Outlook no Windows a partir da versão 2111 (build 14701.20000). Para recuperar um token de acesso em builds mais antigos, use OfficeRuntime.auth.getAccessToken . Para obter mais informações, consulte Habilitar SSO (logon único) em suplementos do Outlook que usam ativação baseada em eventos.

Exemplos

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

Chama o ponto de extremidade do Azure Active Directory V 2.0 para obter um token de acesso para o aplicativo Web do seu suplemento. Permite que os suplementos identifiquem usuários. O código do lado do servidor pode usar esse token para acessar o Microsoft Graph para o aplicativo Web do suplemento usando o fluxo OAuth "em nome de".

Importante: no Outlook, essa API não será compatível se o suplemento for carregado em uma caixa de correio do Outlook.com ou do Gmail.

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

Parâmetros

Retornos

Comentários

Aplicativos: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Essa API exige uma configuração de logon única que preencha o suplemento para um aplicativo do Azure. Os usuários do Office entram com Contas Organizacionais e Contas Microsoft. O Microsoft Azure retorna tokens destinados a ambos os tipos de conta de usuário para acessar recursos no Microsoft Graph.

Exemplos

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

Chama o ponto de extremidade do Azure Active Directory V 2.0 para obter um token de acesso para o aplicativo Web do seu suplemento. Permite que os suplementos identifiquem usuários. O código do lado do servidor pode usar esse token para acessar o Microsoft Graph para o aplicativo Web do suplemento usando o fluxo OAuth "em nome de".

Importante: no Outlook, essa API não será compatível se o suplemento for carregado em uma caixa de correio do Outlook.com ou do Gmail.

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

Parâmetros

Retornos

Comentários

Aplicativos: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Essa API exige uma configuração de logon única que preencha o suplemento para um aplicativo do Azure. Os usuários do Office entram com Contas Organizacionais e Contas Microsoft. O Microsoft Azure retorna tokens destinados a ambos os tipos de conta de usuário para acessar recursos no Microsoft Graph.

Obtém informações sobre o usuário conectado. O suplemento pode passar essas informações para a biblioteca de autenticação da Microsoft (MSAL.js) para obter um token de acesso para a sessão atual.

getAuthContext(): Promise<AuthContext>;

Retornos

Promise para o objeto AuthContext.

Comentários

Hosts: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: NestedAppAuth 1.1

Exemplos

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