Configurar conexões OAuth na Control Room
- Última atualização2024/12/16
Configurar conexões OAuth na Control Room
OAuth é um protocolo aberto de autorização padrão seguro, eficiente e fácil de usar que ajuda a proteger a privacidade do usuário. Ele define como delegar ou dar autorização a aplicativos para acessar recursos (como APIs ou dados do usuário remotos ou de terceiros) sem que o usuário precise apresentar as credenciais de nome de usuário e senha. Atualmente, essa configuração só é necessária se você estiver concluindo a configuração da conexão PixieBrix.
Para obter mais informações, consulte OAuth 2.0.
OAuth oferece suporte a um conjunto de métodos predefinidos chamados tipos de concessão. Cada tipo de concessão tem requisitos e fluxos específicos, dependendo do cenário. As conexões OAuth da Control Room oferecem suporte aos seguintes tipos de concessão:
- Fluxo de código de autorização
- Fluxo de código de autorização com chave de prova para troca de código (PKCE)
- Fluxo de credenciais de clientes
Arquitetura de OAuth
Com as conexões OAuth gerenciadas na Control Room, você pode gerenciar, de forma centralizada, as conexões e o ciclo de vida do token por meio da Control Room. Além disso, é possível armazenar com segurança os tokens necessários para autenticar e autorizar o acesso a aplicativos corporativos sem precisar obtê-los em cada tempo de execução da automação.As conexões OAuth configuradas na Control Room são enviadas para os aplicativos corporativos correspondentes para fins de autenticação.
- Criar e gerenciar conexões para cada aplicativo SaaS usado nas automações.
- Gerenciar o ciclo de vida do token para tokens compartilhados e específicos do usuário.
- Proteger o armazenamento de tokens usando níveis de criptografia padrão do setor.
- Conceder permissões e acesso baseado em funções para gerenciar e consumir as conexões OAuth dentro das automações.
Exemplo de fluxo de trabalho do OAuth : O exemplo a seguir descreve como configurar, criar e usar a conexão do OAuth:
- Criar uma conexão para um aplicativo SaaS corporativo.
- Inserir os detalhes de autenticação, como: ID do cliente, segredo do cliente, URL de autorização e assim por diante.
- (Opcional) Salvar as credenciais de login e testar a conexão.
- Convidar funções a usar essa conexão ou autenticar para Bot Runners não assistidos.
- Salvar e gerenciar a conexão.
- Criar uma Tarefa de API ou um Task Bot.
- Adicionar ação de autenticação para pacotes.
- Selecionar o tipo de autenticação (conexão OAuth de Control Room), o nome da conexão e as informações do aplicativo corporativo.
Ver Usar conexão OAuth.
Tokens OAuth
OAuth fornece os seguintes tipos de token:
- Token de acesso
- Uma longa cadeia de caracteres que serve como credencial usada para acessar recursos protegidos.
- Token de atualização
- Um token especial de longa duração usado para obter um novo token de acesso quando o token de acesso existente expira. O token de atualização fornece um token de acesso de curta duração em vez de coletar credenciais do usuário sempre que um novo token de acesso for necessário. A Control Room usa o token de atualização para obter um novo token de acesso do servidor de autorização (AS).
Ao usar o OAuth, o token de acesso e o token de atualização são retornados n mesma resposta durante o processo de troca de token chamado Resposta do token de acesso.
Tokens do OAuth na Control Room
-
Compartilhado: O tipo de token compartilhado é normalmente usado em automações não assistidas em que a autenticação e o consentimento do usuário não são obrigatórios. Para configurar e usar esse tipo de token na Control Room, você deve configurar as seguintes opções:
- Na seção Gerenciar conexões pode criar conexões OAuth. Esse usuário deve selecionar a opção Salvar credenciais de login na tela Testar conexão e salvar credenciais ao criar uma conexão, para que um token compartilhado seja gerado. Consulte Criar a conexão de OAuth. , um usuário com a permissão
- Quando um usuário estiver usando essa conexão em seus bots, será preciso selecionar a opção de tipo de token Compartilhado, na opção Escolher uma conexão. Consulte Usar conexão OAuth.
-
Específico do usuário: O tipo de token específico do usuário é normalmente usado em automações assistidas em que a autenticação e o consentimento do usuário são obrigatórios. Para configurar e usar esse tipo de token na Control Room, você deve configurar as seguintes opções:
- Na seção Gerenciar conexões pode criar conexões OAuth. Esse usuário não deve selecionar a opção Salvar credenciais de login na tela Testar conexão e salvar credenciais. Em vez disso, o usuário deve convidar funções para usar a conexão selecionando as apropriadas na tela Convidar funções. Consulte Criar a conexão de OAuth.
Usuários incluídos nas respectivas funções serão notificados sobre a conexão atribuída, se tiverem se inscrito para receber as notificações de eventos. Consulte Notificações.
, um usuário com a permissão - O usuário usando a conexão Específico de usuário em seus bots deve autenticar a conexão na seção antes de usá-la. Consulte Autenticar conexões OAuth específicas do usuário.
- Quando o usuário estiver usando essa conexão em seus bots, será preciso selecionar a opção de tipo de token Específico do usuário, na opção Escolher uma conexão. Consulte Usar conexão OAuth.
- Na seção Gerenciar conexões pode criar conexões OAuth. Esse usuário não deve selecionar a opção Salvar credenciais de login na tela Testar conexão e salvar credenciais. Em vez disso, o usuário deve convidar funções para usar a conexão selecionando as apropriadas na tela Convidar funções. Consulte Criar a conexão de OAuth.
Benefícios da integração OAuth com a Control Room
Ao integrar o OAuth à Control Room, você:
- Apresenta um modelo seguro e padrão para automações para autenticar e autorizar aplicativos corporativos.
- Elimina a necessidade de inserir manualmente as credenciais no tempo de execução ou de codificar as credenciais nas automações.
- Garante que os tokens de acesso sejam sempre válidos e estejam disponíveis para automações no tempo de execução, obtendo-os antes do tempo de expiração, eliminando, assim, a necessidade de os usuários passarem pelo processo de autenticação para obtê-los.
- Evita a tarefa repetitiva de configurar os parâmetros OAuth para cada automação que usa a conexão OAuth. As conexões são referenciadas em automações usando o tipo de provedor de aplicativos corporativos.
Gerenciamento do ciclo de vida do token
Todos os tokens de acesso têm um tempo de expiração determinado pelo servidor de autorização (AS). Os tokens são atualizados usando o mecanismo de atualização de token para estender a validade do token (emitindo um novo token). Com uma abordagem centralizada, a Control Room gerencia o ciclo de vida do token e valida cada token antes da execução de bot.