Compartilhar via

Office.Auth interface

  • Referência
Pacote:
office

O espaço de nomes da Autenticação do Office, Office.auth, fornece métodos para a aplicação cliente do Office obter tokens de acesso à aplicação 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.

Comentários

Exemplos

// 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é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 utilizadores. O código do lado do servidor pode utilizar este token para aceder ao Microsoft Graph para a aplicação Web do suplemento através do fluxo OAuth "em nome de". Essa API exige uma configuração de logon única que preencha o suplemento para um aplicativo do Azure. Os utilizadores do Office iniciam sessão 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.
getAccessTokenAsync(options, callback)

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 utilizadores. O código do lado do servidor pode utilizar este token para aceder ao Microsoft Graph para a aplicação Web do suplemento através do fluxo OAuth "em nome de".

Importante: no Outlook, esta API não é suportada se o suplemento for carregado numa caixa de correio Outlook.com ou gmail.
getAccessTokenAsync(callback)

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 utilizadores. O código do lado do servidor pode utilizar este token para aceder ao Microsoft Graph para a aplicação Web do suplemento através do fluxo OAuth "em nome de".

Importante: no Outlook, esta API não é suportada se o suplemento for carregado numa caixa de correio Outlook.com ou gmail.
getAuthContext()

Obtém informações sobre o utilizador com sessão iniciada. O suplemento pode transmitir estas informações à biblioteca de autenticação da Microsoft (MSAL.js) para obter um token de acesso para a sessão atual.

Detalhes do método

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 utilizadores. O código do lado do servidor pode utilizar este token para aceder ao Microsoft Graph para a aplicação Web do suplemento através do fluxo OAuth "em nome de". Essa API exige uma configuração de logon única que preencha o suplemento para um aplicativo do Azure. Os utilizadores do Office iniciam sessão 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

options
Office.AuthOptions

Opcional. Aceita um AuthOptions objeto para definir comportamentos de início de sessão.

Retornos

Promise<string>

Prometa ao token de acesso.

Comentários

Aplicações: Excel, OneNote, Outlook, PowerPoint Word

Conjunto de requisitos: IdentityAPI 1.3

Importante:

  • No Outlook, esta API não é suportada se carregar um suplemento numa caixa de correio Outlook.com ou Gmail.

  • No Outlook na Web, esta API não é suportada se utilizar o Firefox com a Proteção de Controlo Avançada ativada. Isto resulta no erro 13001 ("O utilizador não tem sessão iniciada no Office").

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

  • Num suplemento de ativação baseado em eventos do Outlook, esta API é suportada no Outlook no Windows a partir da Versão 2111 (Compilação 14701.20000). Para obter um token de acesso em compilações mais antigas, utilize OfficeRuntime.auth.getAccessToken como alternativa. Para obter mais informações, veja Ativar o início de sessão único (SSO) nos suplementos do Outlook que utilizam a ativação baseada em eventos.

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.

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 utilizadores. O código do lado do servidor pode utilizar este token para aceder ao Microsoft Graph para a aplicação Web do suplemento através do fluxo OAuth "em nome de".

Importante: no Outlook, esta API não é suportada se o suplemento for carregado numa caixa de correio Outlook.com ou gmail.

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

Parâmetros

options
Office.AuthOptions

Opcional. Aceita um AuthOptions objeto para definir comportamentos de início de sessão.

callback

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

Opcional. Aceita uma função de chamada de retorno que pode analisar o token para o ID do utilizador ou utilizar o token no fluxo "em nome de" para obter acesso ao Microsoft Graph. Se AsyncResult.status for "bem-sucedido", AsyncResult.value será o token de acesso sem formato AAD v. 2.0.

Retornos

void

Comentários

Aplicações: 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 utilizadores do Office iniciam sessão 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.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.

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 utilizadores. O código do lado do servidor pode utilizar este token para aceder ao Microsoft Graph para a aplicação Web do suplemento através do fluxo OAuth "em nome de".

Importante: no Outlook, esta API não é suportada se o suplemento for carregado numa caixa de correio Outlook.com ou gmail.

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

Parâmetros

callback

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

Opcional. Aceita uma função de chamada de retorno que pode analisar o token para o ID do utilizador ou utilizar o token no fluxo "em nome de" para obter acesso ao Microsoft Graph. Se AsyncResult.status for "bem-sucedido", AsyncResult.value será o token de acesso sem formato AAD v. 2.0.

Retornos

void

Comentários

Aplicações: 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 utilizadores do Office iniciam sessão 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.

getAuthContext()

Obtém informações sobre o utilizador com sessão iniciada. O suplemento pode transmitir estas informações à biblioteca de autenticação da Microsoft (MSAL.js) para obter um token de acesso para a sessão atual.

getAuthContext(): Promise<AuthContext>;

Retornos

Promise<Office.AuthContext>

Prometa ao objeto AuthContext.

Comentários

Anfitriões: 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);
}