Autenticação do Gmail

Pré-requisitos

Dependendo do tipo de autenticação selecionado, você precisará de uma das seguintes credenciais:

• Código de autorização do OAuth 2.0: seu endereço de e-mail do Google e a senha associada a sua conta do Google.
• Traga seu próprio aplicativo OAuth 2.0: o ID do cliente, o segredo do cliente e os escopos do seu aplicativo.
• Conta de serviço: Chave da conta de serviço, Email da conta.

Se sua conta não for habilitada pelo Google:

• Entre em contato com o administrador para obter aprovações sobre a criação de conexões.
• Habilite a permissão marcando as opções disponíveis para permitir a criação de uma conexão.

Observação:

Para obter mais detalhes sobre os diferentes tipos de autenticação, consulte o guia Como se conectar às atividades do Google Workspace 365 .

Para obter mais informações sobre o Gmail, acesse o site da documentação do Gmail .

Escopos

O conector solicita as seguintes permissões/escopos:

• Escopos padrão de aplicativos públicos do UiPath: openid, https://www.googleapis.com/auth/userinfo.email, https://www.googleapis.com/auth/userinfo.profile, https://mail.google.com/, https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/gmail.settings.basic.
• Escopos padrão da conta de serviço do Google: openid, https://www.googleapis.com/auth/userinfo.email, https://www.googleapis.com/auth/userinfo.profile, https://mail.google.com/, https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/gmail.settings.basic.
• Traga seu próprio aplicativo OAuth 2.0:
  • Escopos obrigatórios: openid, https://www.googleapis.com/auth/userinfo.email, https://mail.google.com/
  • Escopos mínimos para criar uma conexão: openid, https://www.googleapis.com/auth/gmail.readonly.
  • Lista mínima de escopos necessários para gatilhos do Gmail:
    • openid, https://www.googleapis.com/auth/gmail.readonly – para evento em caixas de correio.
    • openid, https://www.googleapis.com/auth/calendar.readonly – para eventos em calendários.

Observação:

Se você se autenticar usando seu próprio aplicativo OAuth 2.0, você se beneficiará, por padrão, dos escopos configurados na criação do aplicativo. Se você quiser usar as permissões de aplicativo padrão, você pode declarar um escopo common . Isso significa que você usa apenas as permissões configuradas para esse aplicativo. Você também pode declarar escopos adicionais na criação de conexão, usando o campo Escopos . Em seguida, você precisará conceder o consentimento adicional durante o login.

A conexão permite que os produtos da UiPath interajam com dados do Gmail em seu nome. Isso pode incluir dados de leitura, gravação, modificação e exclusão, dependendo das permissões do Gmail. Você sempre pode remover qualquer acesso em sua Conta do Google.

Configuração de um projeto do Google Cloud

Observação:

Esta seção se aplica apenas se você estiver usando o tipo de autenticação Traga seu próprio aplicativo OAuth 2.0 . Se você usar o código de autorização do OAuth 2.0, pule para Adicionar a conexão do Gmail.

Antes de criar uma conexão usando Traga seu próprio aplicativo OAuth 2.0, configure um projeto do Google Cloud para autorizar a comunicação do OAuth com o Gmail.

1. Acesse o Console do Google Cloud e crie um projeto ou selecione um existente. Preencha os detalhes básicos do projeto e selecione Salvar e continuar.
2. No menu de navegação, selecione APIs e serviços e, em seguida, Biblioteca.
3. Pesquise API do Gmail e, em seguida, selecione Habilitar.
4. Selecione Credenciais, em seguida , + Criar Credenciais e, em seguida, ID do cliente OAuth.
5. Em Tipo de aplicativo, selecione Aplicativo da Web e insira um nome.
6. Em URIs de redirecionamento autorizados, adicione https://{baseURL}/provisioning_/callback e, em seguida, selecione Criar.
7. Salve o ID do cliente e o Segredo do cliente em um local seguro.
8. Selecione Tela de consentimento do OAuth e defina as configurações do aplicativo. Se o aplicativo é Interno ou Externo depende da política de segurança da sua organização.
9. Selecione Editar aplicativo, acesse a seção Escopos e selecione Adicionar ou remover escopos.
10. Pesquise por e-mail e selecione os escopos da API do Gmail apropriados. Consulte a seção Escopos para ver o conjunto mínimo exigido. Se você adicionar escopos para APIs adicionais, como o Google Drive, certifique-se de que eles estejam em conformidade com as políticas da sua empresa.
11. Salve suas alterações. Se seu aplicativo for Externo, você pode adicionar usuários de teste na etapa Usuários de teste antes de retornar ao painel do projeto.

Seu ID do cliente e Segredo do cliente agora estão prontos para uso ao criar a conexão do Gmail no Integration Service.

Observação:

Para gerenciar restrições de acesso à API ou permissões de Apps no nível organizacional, consulte a documentação de Apps de terceiros e personalizados do Google.

Adicionar a conexão do Gmail

1. Selecione Orchestrator no inicializador do produto.

2. Selecione uma pasta e navegue até a aba Conexões .

3. Selecione Adicionar conexão.

4. Para abrir a página de criação de conexão, selecione o conector na lista. Você pode usar a barra de pesquisa para encontrar o conector.

5. Selecione seu tipo de autenticação preferido.

   Se você selecionar Traga seu próprio aplicativo OAuth 2.0, selecione o ícone de engrenagem e, em seguida, selecione Traga seu próprio aplicativo OAuth 2.0 e forneça o ID do cliente e Segredo do cliente da configuração do seu projeto do Google Cloud. Você também deve fornecer os escopos necessários para as atividades que planeja usar. Verifique a documentação de cada atividade para saber quais escopos ela requer.

6. Insira as credenciais necessárias e selecione Conectar.

   Para qualquer campo do tipo secreto, você pode selecionar o menu ao lado do campo e escolher Usar ativo de credencial para fazer referência a um ativo de credencial do Orchestrator vinculado a um cofre externo em vez de inserir o valor diretamente. Para obter mais informações, consulte Usar ativos de credenciais para conexões.

Usando a conexão no Studio Desktop

Após criar uma conexão do Gmail no Integration Service, configure sua automação do Studio ou StudioX para usá-la.

1. No Studio, abra Gerenciar pacotes e instale o pacote Google Workspace .

2. Em sua automação, você pode adicionar atividades do Gmail selecionando Instalado, depois Integrações, Google, Workspace e, então, seleciona Gmail.

   Observação:

   Use as atividades Gmail da seção Integrações em vez da atividade Use Gmail legada. A atividade legada não é compatível com conexões do Integration Service e é limitada a uma única conta de usuário codificada.

3. Nas propriedades de cada atividade, selecione a conexão do Gmail que você criou no Integration Service.

Se nem todos os escopos do Gmail estiverem habilitados em seu projeto do Google Cloud, algumas atividades podem falhar. Verifique a documentação de cada atividade para seus escopos exigidos.

Traga seu próprio aplicativo OAuth 2.0

No Integration Service, ao criar uma conexão com um de nossos conectores baseados na API do Google, você pode escolher entre duas opções de autenticação:

• Código de autorização OAuth 2.0 – conecta-se ao aplicativo público da UiPath.
• Traga seu próprio aplicativo OAuth 2.0 – conecta-se a um aplicativo privado do Google Cloud que você cria.

Configuração de escopos

Ao criar uma conexão usando seu próprio aplicativo OAuth 2.0, você tem a opção de personalizar os escopos do aplicativo.

Tokens de atualização para aplicativos OAuth

O Google tem limitações de token de atualização para IDs individuais do cliente do OAuth 2.0. Se o limite for atingido, a criação de um novo token de atualização invalidará automaticamente o token de atualização mais antigo sem aviso. Esse limite não se aplica a contas de serviço (consulte Uso do OAuth 2.0 para aplicativos de servidor a servidor). Para obter mais informações, consulte a documentação oficial do Google .

Uma lista de motivos que podem causar a expiração do token:

• Você revogou o acesso do seu aplicativo.
• O token de atualização não é usado há seis meses.
• Você precisa alterar senhas e o token de atualização contém escopos do Gmail.
• Sua conta excedeu o número máximo de tokens de atualização (ativos) concedidos.
  • Se você solicitar um novo token após o limite ter sido excedido, sua conexão antiga, com base em um token concedido anteriormente, expirará. Apenas a nova conexão ou a última conexão editada/reautenticada (com o token mais recente) funcionará.
• Um administrador definiu qualquer um dos serviços solicitados nos escopos do seu aplicativo como Restrito (o erro é admin_policy_enforced).
• Para APIs do Google Cloud Platform: a duração da sessão definida pelo administrador pode ter sido excedida.

Observação:

O limite está atualmente definido como 100 tokens de atualização por conta do Google por ID do cliente do OAuth 2.0. Este número pode estar sujeito a alterações. Para obter as informações mais recentes, sempre verifique a Documentação do Google.

Há um limite maior para o número total de tokens de atualização que uma conta de usuário ou conta de serviço pode ter em todos os clientes. Usuários regulares não excederão esse limite, mas uma conta de desenvolvedor usada para testar uma implementação pode.

Para garantir que esse limite não seja excedido, a UiPath oferece aos usuários a capacidade de criar seus próprios aplicativos OAuth e se conectar usando o tipo de autenticação Traga seu próprio aplicativo. Certifique-se de seguir as práticas recomendadas do Google ao criar seu aplicativo OAuth. Para obter detalhes sobre como criar um aplicativo OAuth, consulte a documentação oficial do Google .

Observação:

A invalidação de tokens resulta em conexões com falha e as automações não podem ser executadas sem corrigir as conexões.