OfficeRuntime.Auth interface

Pacote:
office-runtime

Aviso

Essa API foi preterida.

Use the Office.Auth interface instead.

Interface que contém APIs relacionadas à autorização.

Comentários

Os métodos nessa interface são equivalentes aos da interface Office.auth. Se novos tipos de autenticação forem adicionados no futuro, eles serão adicionados apenas à Office.auth interface. Para simplificar, os exemplos de código em toda a documentação usam Office.auth.

Exemplos

// Get the auth context object and use it to get an
// access token.
const auth = OfficeRuntime.auth;
const accessToken = await auth.getAccessToken();

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

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 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 da 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
OfficeRuntime.AuthOptions

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

Retornos

Promise<string>

promessa ao token de acesso.

Comentários

Aplicativos: Excel, 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 é compatível 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 chamar getAccessToken.

Exemplos

async function getUserData() {
  try {
      const auth = OfficeRuntime.auth;
      let userTokenEncoded = await auth.getAccessToken();
      let userToken = jwt_decode(userTokenEncoded); // Using the https://www.npmjs.com/package/jwt-decode library.
      console.log(userToken.name); // user name
      console.log(userToken.preferred_username); // email
      console.log(userToken.oid); // user id     
  }
  catch (exception) {
      if (exception.code === 13003) {
          // SSO is not supported for domain user accounts, only
          // Microsoft 365 Education or work account, or a Microsoft account.
      } else {
          // Handle error
      }
  }
}