---
title: Configuração para autenticação gov.br
slug: cit-9/configuracao-para-autenticacao-govbr
description: Learn how to implement OAuth2 authentication on your platform with this comprehensive document. It covers all the required configurations and parameters, along with detailed explanations of the authentication method. Explore examples of the login process 
docTags: 
createdAt: 2023-03-24T19:17:10.000Z
---

## Objetivo

Este documento descreve os requisitos e configurações necessárias para <font color="#2166ae">**implementar a autenticação OAuth2** ***gov.br***</font> na plataforma, conforme documentação disponível no [site do Roteiro de Integração do Login Único](https://manual-roteiro-integracao-login-unico.servicos.gov.br/pt/stable/).

## Parametrização

- A propriedade *AUTHENTICATION\_PROTOCOL* do arquivo **application.ini&#x20;**&#x64;eve 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](https://sso.staging.acesso.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:&#x20;**&#x41;tivo
- **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&#x20;*****gov.b**********r***” para o atributo **Nome do cliente** é recomendado pela documentação disponível no [site do Roteiro de Integração do Login Único](https://manual-roteiro-integracao-login-unico.servicos.gov.br/pt/stable/).

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/mRkSfUVyhpDIdCkHMBj5w_image.png)

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

- **CPF/CNPJ:** sub

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/WgTU-FkYR8S0J58MqihT8_image.png)

## Autenticação

Exemplo de tela de login quando a propriedade *AUTHENTICATION\_PROTOCOL* tem o valor **BOTH**:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/gTHc9bbeq01gOwk4PSNwN_image.png)

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/MrweuUIy6Fa92qcgakyps_image.png)

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/RvW_hJ6ym0m0x9bJMqE1-_image.png)

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/kl9yrlYxf48SJj0dp_uSV_image.png)

Escolha “**Tentar de outra forma**”:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/j8KNKC9Hh88LJk7KIshdS_image.png)

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/nN7_H-fKhAq10rSrAR0Df_image.png)

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

:::hint{type="warning"}
⚠️ <u>**Atenção!**</u> É importante escolher a opção “**Por e-mail**” para que o usuário já seja criado com Email no Plataforma
:::

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/LwjKuC95rmvZZ5iCfiqGV_image.png)

Informe o código de verificação:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/Y9_USsag8B2a4gdPOgqob_image.png)

E defina uma senha:

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/15ghzAa87-PZYZCtENkLu_image.png)

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/R_fW4SB0Md3C4Ty3-eaeI_image.png)

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

![](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/KzGO09-J18lMUfol0ad6C_image.png)

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