Office.Auth interface

Referência

Pacote:: office

O namespace do Office Auth, Office.auth, fornece um método que permite que o aplicativo cliente do Office obtenha um token de acesso ao aplicativo Web do suplemento. Indiretamente, isso também habilita o suplemento para acessar os dados do Microsoft Graph do usuário sem exigir que o usuário se conecte uma segunda vez.

Métodos

getAccessToken(options)

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 os 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 do". Essa API exige uma configuração de logon única que preencha o suplemento para um aplicativo do Azure. Os usuários do Office entrarão com contas organizacionais e contas da Microsoft. O Microsoft Azure retorna tokens destinados a ambos os tipos de conta de usuário para acessar recursos no Microsoft Graph.

getAccessTokenAsync(options, callback)

Importante: no Outlook, essa API não terá suporte se o suplemento for carregado em uma caixa de correio Outlook.com ou Gmail.

Aviso: getAccessTokenAsync foi preterido. Use Office.auth.getAccessToken em vez disso.

getAccessTokenAsync(callback)

Importante: no Outlook, essa API não terá suporte se o suplemento for carregado em uma caixa de correio Outlook.com ou Gmail.

Aviso: getAccessTokenAsync foi preterido. Use Office.auth.getAccessToken em vez disso.

Detalhes do método

getAccessToken(options)

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

Parâmetros

options: Office.AuthOptions

Opcional. Aceita um AuthOptions objeto para definir comportamentos de logon.

Retornos

Promise<string>

Prometa 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 Outlook.com ou Gmail.
Em Outlook na Web, essa API não terá suporte se você usar o navegador Safari. Isso resulta no erro 13001 ("O usuário não está conectado ao Office").
No Outlook na Web, se você usar o método displayDialogAsync para abrir uma caixa de diálogo, deverá fechar a caixa de diálogo antes de poder chamar getAccessToken.
Em um suplemento de ativação baseado 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, confira Habilitar o SSO (logon único) em suplementos do Outlook que usam ativação baseada em evento.

Exemplos

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

getAccessTokenAsync(options, callback)

Aviso

Essa API foi preterida.

Use Office.auth.getAccessToken instead.

Importante: no Outlook, essa API não terá suporte se o suplemento for carregado em uma caixa de correio Outlook.com ou Gmail.

Aviso: getAccessTokenAsync foi preterido. Use Office.auth.getAccessToken em vez disso.

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

Parâmetros

options: Office.AuthOptions

Opcional. Aceita um AuthOptions objeto para definir comportamentos de logon.

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

Opcional. Aceita uma função de retorno de chamada que pode analisar o token para a ID do usuário ou usar o token no fluxo "em nome de" para obter acesso ao Microsoft Graph. Se AsyncResult.status for "bem-sucedido", o AsyncResult.value token de acesso formatado para AAD v. 2.0 bruto.

Retornos

void

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 entrarão com contas organizacionais e contas da Microsoft. O Microsoft Azure retorna tokens destinados a ambos os tipos de conta de usuário para acessar recursos no Microsoft Graph.

Exemplos

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)

Aviso

Essa API foi preterida.

Use Office.auth.getAccessToken instead.

Importante: no Outlook, essa API não terá suporte se o suplemento for carregado em uma caixa de correio Outlook.com ou Gmail.

Aviso: getAccessTokenAsync foi preterido. Use Office.auth.getAccessToken em vez disso.

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

Parâmetros

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

Retornos

void

Comentários

Aplicativos: Excel, OneNote, Outlook, PowerPoint, Word

Conjunto de requisitos: IdentityAPI 1.3

Office.Auth interface

Métodos

Detalhes do método

getAccessToken(options)

Parâmetros

Retornos

Comentários

Exemplos

getAccessTokenAsync(options, callback)

Parâmetros

Retornos

Comentários

Exemplos

getAccessTokenAsync(callback)

Parâmetros

Retornos

Comentários

Comentários

Recursos adicionais