GE Parâmetros OAuth

De CIGAM WIKI

Voltar

Utilidades/Diversos > Genéricos > Parâmetros > Parâmetros OAuth

Parâmetros OAuth

A partir da [Versão 241007 1], foi disponibilizado o cadastro de Parâmetros OAuth, que deve ser utilizado para configurar as definições necessárias para a autorização OAuth (Open Authorization) na autenticação de uma ampla gama de serviços, como o envio de e-mails. Esses parâmetros garantem uma integração segura e padronizada, permitindo que o serviço acesse recursos protegidos em nome do usuário, sem a necessidade de compartilhar diretamente suas credenciais.

Parametros OAuth


Campos

Para configurar o OAuth 2.0 no CIGAM, siga as instruções abaixo, acessando a tela de Parâmetros OAuth:

Campo Id: Código único, gerado pelo sistema para identificar o cadastro de parâmetros a serem utilizados ao obter a autorização em determinado serviço. Este campo não pode ser alterado pelo usuário.
Campo Descrição: Permite fornecer uma breve explicação sobre a parametrização OAuth. Utilizado para descrever a finalidade da configuração. Por exemplo, uma descrição como "Microsoft 365 - OAuth 2.0" indica que a parametrização está relacionada à utilização do protocolo OAuth 2.0 para integração com os serviços do Microsoft 365.
Campo Nome do campo: Esta coluna, localizada na parte inferior do programa, lista os campos específicos que compõem a configuração OAuth, como "Tenant ID", "Client ID", entre outros. Cada campo especifica diferentes partes da configuração necessárias para autenticar e autorizar a aplicação no Azure Active Directory (Azure AD).
Tenant ID: Inserir o Tenant ID obtido do Azure AD. Este é o identificador único da organização no Azure onde o aplicativo está registrado.
Client ID: Inserir o Client ID do aplicativo registrado no Azure AD. Este é o identificador do aplicativo e é utilizado para autenticar a aplicação.
Client Secret: Inserir o Client Secret gerado no Azure AD. Esta é a chave secreta associada ao aplicativo, necessária para autenticar e obter tokens de acesso.
Redirect Uri: Inserir a URL de redirecionamento configurada no Azure AD. Esta URL define para onde o usuário será redirecionado após a autenticação, devendo corresponder ao valor registrado no Azure.
Auth Endpoint e Token Endpoint: URLs de autenticação e de token do Microsoft 365. Essas URLs são utilizadas para solicitar a autenticação do usuário e a troca de tokens no Microsoft 365. Esses campos já vêm preenchidos por padrão pelo sistema.
Scopes: Define os escopos de permissões necessários. Estes escopos especificam as permissões que o aplicativo solicitará durante a autenticação. Esses campos já vêm preenchidos por padrão pelo sistema.
Get User Uri e Send Mail Uri: URLs específicas para obter informações do usuário e para o envio de e-mails, respectivamente. Esses campos já vêm preenchidos por padrão pelo sistema.
Logout Endpoint: URL para logout, se aplicável. Esses campos já vêm preenchidos por padrão pelo sistema.
Validade: Permite colocar a data de validade do token conforme definido no Azure AD.
Campo Dado: Esta coluna exibe os valores correspondentes a cada campo de configuração, como IDs, URIs, ou outras informações necessárias para a configuração OAuth. Os valores inseridos são usados pelo CIGAM para se comunicar com o Azure AD, permitindo a autenticação e autorização OAuth.

Copiar e excluir parâmetros

Estando posicionado sobre um cadastro de parâmetros original, aqueles cujo Id possui o ".1" como sufixo no seu código, é possível criar uma cópia a partir do botão 'Copiar'. As cópias podem ser utilizadas para realizar autorizações OAuth com diferentes parâmetros.

Caso o usuário tente realizar a cópia de um cadastro que não seja original, será exibida a seguinte mensagem:

CGM-7291: Ação disponível apenas para cadastros originais. Para copiar, utilize o parâmetro OAuth com o Id 001.1.

A exclusão de cadastros é permitida apenas para cópias. Se o usuário tentar excluir um cadastro de parâmetros original, será exibida a seguinte mensagem:

CGM-7289: Parâmetro OAuth criado pelo sistema. Exclusão não permitida.

Caso o usuário tente excluir uma cópia de cadastro de parâmetros que esteja em uso, ou seja, esteja informada na configuração de sistema 'GE - AM - 3233 - OAuth para envio de e-mail', será exibida a seguinte mensagem:

CGM-7290: Parâmetro OAuth informado na configuração 'GE - AM - 3233 - OAuth para envio de e-mail'. Exclusão não permitida.

Voltar ao início

Versão 241007

  1. Liberado a partir da OS 373456/716.

Páginas referenciadas