Administração da Plataforma
...
Introdução à Administração de ...
Autenticação

Configuração para autenticação gov.br

8min

Objetivo

Este documento descreve os requisitos e configurações necessárias para implementar a autenticação OAuth2 gov.br na plataforma, conforme documentação disponível no site do Roteiro de Integração do Login Único.

Parametrização

  • A propriedade AUTHENTICATION_PROTOCOL do arquivo application.ini deve estar com o valor OAUTH2 (somente autenticação Oauth2 externa) ou BOTH (autenticação interna e externa).
  • A propriedade AUTHENTICATION_CREATE_USER (default FALSE) deve estar com o valor TRUE, caso a opção seja criar o usuário automaticamente quando ele não existe no banco de dados do Plataforma.
  • Como os usuários do ambiente de testes do gov.br tem o mesmo nome (Meu nome) é importante que o parâmetro 277 (Permite o cadastro de colaborador com mesmo nome?) esteja habilitado com “sim”.

Método de Autenticação

Na funcionalidade Parametrização > Método de autenticação > Oauth2 deve ser criado um método de autenticação com as seguintes informações:

  • Tipo de autenticação: OAuth2 - Externa
  • Provider: Outros
  • Domínio: govbr
  • Nome do cliente: Entrar com GOV.BR
  • ID do cliente: {client id fornecido pelo órgão}
  • Chave secreta do cliente: {client secret fornecido pelo órgão}
  • Situação: Ativo
  • URL de autenticação: https://sso.staging.acesso.gov.br/token
  • URI autorização: https://sso.staging.acesso.gov.br/authorize
  • URI informações do usuário: https://sso.staging.acesso.gov.br/userinfo
  • Escopo: openid+(email/phone)+profile
  • Atributo identificador do usuário: sub
  • Renovar o token automaticamente: sim

A descrição “Entrar com gov.br” para o atributo Nome do cliente é recomendado pela documentação disponível no site do Roteiro de Integração do Login Único.

Os atributos URL de autenticação, URI autorização e URI informações do usuário acima estão apontando para o ambiente de testes da autenticação gov.br

Exemplo configurado para o ambiente de homologação

Document image


A aba “Mapeamento de campos” deve estar com os valores:

  • CPF/CNPJ: sub
Document image


Autenticação

Exemplo de tela de login quando a propriedade AUTHENTICATION_PROTOCOL tem o valor BOTH.

Ao clicar em “entrar com gov.br” o usuário é redirecionado para a tela de autenticação configurada no domínio govbr:

Document image


No ambiente de testes gov.br, digite um CPF válido e cumpra as etapas de validação do usuário:

Document image


Para simplificar o processo escolha opção “Não tenho celular”:

Document image


Escolha “Tentar de outra forma”:

Document image


O nome da mãe é sempre "MAMAE" e a data de nascimento é sempre 01/01/1980:

Document image


Informe um e-mail para receber o código de verificação:

⚠️ Atenção! É importante escolher a opção “Por e-mail” para que o usuário já seja criado com Email no Plataforma

Document image


Informe o código de verificação:

Document image


E defina uma senha:

Document image


Logo em seguida, o usuário é redirecionado para a tela de login da plataforma. Escolha novamente a opção “Entrar com gov.br”, digite o usuário e a senha cadastrados na etapa anterior e autorize o acesso.

Pronto! O usuário foi cadastrado no Plataforma com o nome de usuário {domínio cadastrado no método de autenticação}\CPF.

Document image


O perfil e a unidade do usuário são definidos nos parâmetros 39 e 390, respectivamente.