Cadastro de novos provedores OAuth

Aprenda como criar um novo provedor OAuth na Digibee Integration Platform.

OAuth é um protocolo de autorização que permite que uma aplicação acesse recursos e informações de um usuário sem a necessidade de usar credenciais. Na Digibee Integration Platform, os usuários podem registrar provedores e usá-los de forma independente e autônoma em suas integrações.

Nesta documentação, você aprenderá como criar um novo provedor e como usá-lo para criar outros provedores no futuro.

Uma vez que a aplicação seja criada no provedor, é possível registrar seu novo provedor OAuth na Digibee Integration Platform. Para saber como criar uma aplicação, leia o artigo sobre a arquitetura OAuth na Digibee.

Criar um novo provedor

Ao criar um novo provedor, ele pode se tornar um provedor base. Isso significa que poderá ser usado como um tipo de "modelo" para facilitar o preenchimento das informações ao criar novos provedores.

Se você quiser criar um novo provedor com base em um já existente, selecione o provedor desejado no campo Provedor base. As informações de Auth URL, Grant Token URL e Refresh Token URL serão preenchidas automaticamente. Você deverá incluir o ID do cliente, Chave Privada, Escopo e, se necessário, o Code.

Para criar um novo provedor:

1. Em Configurações, acesse a tela Contas.

2. Clique no submenu Provedor OAuth.

3. Clique em Criar.

4. Na seção Detalhes do provedor, preencha os seguintes campos:

   • Nome do provedor: O nome que deseja colocar no provedor.

   • URL de autenticação: URL para solicitar autorização ao provedor.

   • Prompt:

     1. consent (padrão): Solicita que o usuário conceda permissões à aplicação após fazer login.

     2. login: Faz com que o usuário insira suas credenciais na solicitação, impedindo o uso de single sign-on (logon único).

     3. none: Garante que nenhum prompt seja exibido ao usuário. Se o single sign-on silencioso falhar, a plataforma de identidade da Microsoft retorna um erro interaction_required.

     4. select_account: Interrompe o single sign-on para exibir a seleção de conta, listando todas as contas ativas ou lembradas, ou oferecendo a opção de usar uma conta diferente.

   • Grant Token URL: URL usada para solicitar o token ao provedor.

   • Refresh Token URL: URL usada para renovar o token junto ao provedor. Redirect URI: O Redirect URI é gerado automaticamente ao abrir o formulário de criação do provedor. Code: Opcional. A necessidade de preenchimento depende do provedor.

5. Preencha as credenciais:

   • ID do cliente: Valor de identificação usado como nome de usuário.

   • Chave Privada: Senha emitida pelo cliente autenticador.

   • Certificado e senha do certificado: Opcionais. O arquivo do certificado e senha do certificado. Formatos aceitos: .pem, .crt, .p12, .pfx.

   • Escopo: Os dados ou funcionalidades que a plataforma pode acessar via provedor. As regras de escopo variam de acordo com o provedor.

   • Delimiter (delimitador): O padrão é uma vírgula (,) e só deve ser alterado se necessário. Por exemplo, a Microsoft usa um espaço em branco (" ") como delimitador.

6. Clique em Salvar.

Após a criação do novo provedor, será possível editá-lo ou excluí-lo na página de Provedores OAuth. Durante a edição, campos sensíveis como ID do cliente e Chave Privada aparecerão em branco e não serão exibidos por motivos de segurança.