Para utilização desta rotina, é pré-requisito o cadastramento dos seus respectivo Documento, Transação e Funções. O quadro abaixo detalha como realizar estes cadastros.

Após validar e/ou cadastrar as configurações acima, o sistema está apto para seguir com as configurações da autenticação Oauth seguindo os passos abaixo.

Selecionar módulo segurança conforme imagem abaixo.

Acessar item de menu referente à transação de Configuração da autenticação Oauth, autenticação esta utilizada pelas suítes de serviços, conforme exibido na figura abaixo.

 A transação de manutenção de configuração da autenticação Oauth possui 4 funções, são elas:

1. Incluir;
2. Alterar;
3. Visualizar;
4. Excluir.

Abaixo detalhes de como utilizar cada uma das 4 funcionalidades da transação.

Acionar a função Incluir, destacada na figura abaixo. Para esta funcionalidade não é necessário realizar consulta uma vez que a mesma não permite a seleção de registros. Todos os campos devem ser informados, abaixo deste quadro mais detalhes do conteúdo que deve constar nos campos. Após realizar pesquisa, acionando o botão Pesquisar, selecionar o registro desejado e clicar na função alterar, conforme figura abaixo. Na tela de alteração, realizar a alteração no campo desejado e acionar o botão Alterar. Cabe ressaltar que não existe a possibilidade de alterar o campo Identificação do Usuário. Após realizar pesquisa, acionando o botão Pesquisar, selecionar o registro desejado e clicar na função visualizar, conforme figura abaixo. As informações do cliente selecionado são exibidas somente para leitura e nenhuma outra ação é permitida nesta tela. Após realizar pesquisa, acionando o botão Pesquisar, selecionar o registro desejado e clicar na função excluir, conforme figura abaixo. Esta funcionalidade permite a seleção de mais de um registro ao mesmo tempo. A tela de detalhe de exclusão exibe todos os registros selecionados na tela de filtro e, para realizar a exclusão, basta acionar o botão Confirmar.

Preenchimento dos campos:

• Identificação do Usuário - Nome que será utilizado pela aplicação cliente para requisição de autenticação;
• Validade Token Acesso - Tempo, em segundos, de validade do token de acesso;
• Validade Refresh Token - Tempo, em segundos, de validade do refresh token (token de atualizaçã);
• Tipo de permissão - Mais de um tipo de permissão pode ser selecionado ao mesmo tempo, lembrando que o tipo REFRESH_TOKEN trabalha em conjunto com PASSWORD. Abaixo os tipos de autenticação suportados pelas aplicações TOTVS, assim como uma breve explicação para cada um deles. Maiores informações podem ser obtidas no site oficial dos desenvolvedores Oauth clicando aqui.

• • CLIENT_CREDENTIALS - Utilizado para requisitar acesso para uma aplicação, nesta opção, não é retornado um token de atualização, logo, após expirar o token retornado, outra requisição deve ser feita;
  • PASSWORD - Utilizado para requisitar acesso para um determinado usuário, usuário este deve estar previamente cadastrado no sistema de segurança. Ao realizar este tipo de requisição, além do token de acesso, é retornado um token de atualização (Refresh Token).
  • REFRESH_TOKEN - Utilizado para renovar um acesso utilizando um token de atualização retornado em uma requisição anterior. Este tipo de requisição retornará novos tokens de acesso e atualização.