Configuração de acesso aos e-mails do Office 365 (OAuth2.0) no Azure
Código: HD-000049 || Criado em 01/03/2023 12:08:50 || Atualizado em 01/03/2023 12:08:50 || Autor: Andrea OliveiraDefinição
O Gestão DF-e está preparado para conectar-se a funcionalidades de e-mail do Office 365 utilizando autenticação moderna (OAuth2.0), com tokens de acesso. Para isso, é necessário realizar configurações específicas no Portal de Gerenciamento do Microsoft Azure. As configurações de acesso ao e-mail, permitirão que o Gestão DF-e leia e envie mensagens utilizando as credenciais do Office 365.
Requisitos:
- Usuário de acesso ao Azure Active Directory, com permissão de administrador
- Conta de e-mail no Office365, válida
Configurações no Portal Azure
Acesse o Portal Azure (https://portal.azure.com ), com as suas credencias. Na pesquisa disponibilizada na parte superior da tela, digite “Azure Active Directory”, e selecione a opção referente.
Ø Configurar um novo aplicativo
No menu lateral, à esquerda da tela, selecione a opção [Registros de Aplicativo] (App Registrations). E acione o botão [Novo registro] (New registration), no menu superior.
Em [Nome] (Name), digite o nome como o aplicativo será reconhecido dentro das configurações. Por exemplo: Gestão DFe
Na opção [Tipos de conta com suporte] (Supported account types), selecione [Contas somente neste diretório organizacional (nomedodiretorio – único locatário)]. (Accounts in this organizational directory Only)
Em [URI de Redirecionamento] (Redirect URI), por enquanto deixar em branco, pois será configurado em outro momento.
Acione o botão [Registrar]
(Register)
Após registrar as configurações, será apresentado a tela contendo as credenciais de acesso e configuração.
Das credenciais apresentadas, as que serão utilizadas na configuração do Gestão DF-e, são: [Application (cliente)ID] (ID do aplicativo (cliente)) e [Directory (tenant) ID] (ID do diretório (locatário).
Ø Configurar URLs
No portal Azure, é necessário informar quais serão as URLs de redirecionamento. Essas URLs normalmente são utilizadas na função de SSO (Single Sign On).
Para a funcionalidade
de leitura de e-mails, é necessário configurar a URL para que, após o
Administrador dar consentimento de acesso às APIs, a Microsoft redirecione para
a página cadastrada.
Nota:
Por padrão poderá ser configurada a mesma URL de login para o Gestão DF-e. As
informações de confirmação enviadas pela Microsoft não são necessárias.
No menu lateral, à esquerda da tela, selecione a opção [Autenticação] (Authentication), em [Configurações da plataforma] (Platform configurations), acione a opção [Adicionar uma Plataforma] (Add a platform)
Selecione a opção [Web]
Nas opções [URIs de
Redirecionamento] (Redirect URIs) e [URL de logoff do canal
frontal] (Front-channel logout URL) preencher: endereço do Gestão
DF-e +/telas/LoginSSOConfirma.aspx/
Por exemplo: https://hom.dynamicca.com.br/telas/LoginSSOConfirma.aspx
Importante:
para o correto funcionamento, apenas HTTPS é aceito.
Selecionar a opção [Tokens de ID (usados para fluxos implícitos e híbridos)] (ID tokens (used for implicit and hybrid flows)
Acione o botão [Configurar] (Configure)
As informações serão
apresentadas na tela. Caso seja necessário alterar, adicionar novas URLs ou
realizar alguma outra configuração, poderá ser feito diretamente nesta tela,
sempre acionando o botão [Salvar] (Save) após as alterações.
Importante: É recomendável incluir também, o endereço base do Gestão DF-e (exemplo: https://hom.dynamicca.com.br), como [URI de Redirecionamento], para isso, basta selecionar a opção [Adicionar URL], e acionar o botão [Salvar]
Ø Criar o Segredo do Cliente - Client Secret
O Segredo do Cliente, ou Client Secret, é uma chave de configuração utilizada para que o sistema possa acessar o Azure e validar as credenciais do usuário.
No menu lateral, à esquerda da tela, selecione a opção [Certificados e segredos] (Certificates & secrets), em [Segredos do Cliente] (Client Sercret), acione a opção [Novo segredo do cliente](New cliente secret).
Será apresentada a página para preencher a descrição e a data de expiração da chave. Após preencher os dados, acione o botão [Adicionar] (Add)
Nota: a data máxima de expiração é de 24 meses (2 anos)
Após a criação, será exibida a nova chave na tela. O campo [Valor] (Value) deve ser armazenado, pois será utilizado na configuração do Gestão DF-e.
Ø Configurar o acesso à API
Para que o Gestão DF-e possa acessar o Azure e validar o usuário, é necessário das acesso a API do Microsoft Graph.
O Microsoft Graph é um
serviço do Azure que permite consultar diversos cadastros e realizar operações
nas contas e serviços cadastrados.
No menu lateral, à esquerda da tela, selecione a opção [Permissões de APIs] (API permissions) e em [Adicionar uma permissão](Add a permission).
No menu selecionar a opção [Microsoft Graph] e em [Permissões de Aplicativos] (Application permissions)
Será exibida uma lista de permissões. Nessa lista deverá ser selecionada as seguintes opções da API do Microsoft Graph:
- Mail.Read
- Mail.ReadBasic
- Mail.ReadBasic.All
- Mail.ReadWrite
- Mail.Send
- User.Read
- User.Read.All
Para o correto funcionamento, a permissão deve estar com status [Concedido] (Granted)
Importante: Essa permissão precisa do consentimento do Administrador. Caso o usuário não seja um administrador, deverá solicitar ao mesmo que acesse a página e clique no botão [Conceder consentimento do administrador] (Grant admin consente for).
Ø Configurar o Gestão DF-e
Para aplicar as configurações criadas no Gestão DF-e, consulte os artigos:
Configurar Envio de E-mail (SMTP)
Configurar Envio de E-mail (SMTP) em Lote
Manutenção de Dados - Envio de E-mail (SMTP-OAuth2) – em Lote