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.

Setting up a Google Cloud project

Observação:

This section applies only if you are using the Bring your own OAuth 2.0 app authentication type. If you use OAuth 2.0 Authorization code, skip to Add the Gmail connection.

Before creating a connection using Bring your own OAuth 2.0 app, configure a Google Cloud project to authorize OAuth communication with Gmail.

1. Go to the Google Cloud Console and create a project or select an existing one. Fill in the basic project details and select Save and Continue.
2. In the navigation menu, select APIs & Services, then Library.
3. Search for Gmail API, then select Enable.
4. Select Credentials, then + Create Credentials, and then OAuth client ID.
5. Under Application type, select Web application and enter a name.
6. Under Authorized redirect URIs, add https://{baseURL}/provisioning_/callback, then select Create.
7. Save the Client ID and Client secret in a secure location.
8. Select OAuth consent screen and configure the app settings. Whether the app is Internal or External depends on your organization's security policy.
9. Select Edit App, go to the Scopes section, then select Add or Remove Scopes.
10. Search for mail and select the appropriate Gmail API scopes. Refer to the Scopes section for the minimum required set. If you add scopes for additional APIs, such as Google Drive, ensure they comply with your company's policies.
11. Save your changes. If your app is External, you can optionally add test users in the Test users step before returning to the project dashboard.

Your Client ID and Client secret are now ready to use when creating the Gmail connection in Integration Service.

Observação:

To manage API access restrictions or app permissions at the organizational level, refer to Google's Third Party and Custom Apps documentation.

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.

   If you select Bring your own OAuth 2.0 app, select the gear icon, then select Bring your own OAuth 2.0 app and supply the Client ID and Client secret from your Google Cloud project setup. You must also provide the scopes required for the activities you plan to use. Check the documentation of each activity to learn what scopes it requires.

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.

Using the connection in Studio Desktop

After creating a Gmail connection in Integration Service, configure your Studio or StudioX automation to use it.

1. In Studio, open Manage Packages and install the Google Workspace package.

2. In your automation, you can add Gmail activities by selecting Installed, then Integrations, Google, Workspace, and then select Gmail.

   Observação:

   Use the Gmail activities from the Integrations section rather than the legacy Use Gmail activity. The legacy activity does not support Integration Service connections and is limited to a single hardcoded user account.

3. In each activity's properties, select the Gmail connection you created in Integration Service.

If not all Gmail scopes were enabled in your Google Cloud project, some activities may fail. Check each activity's documentation for its required scopes.

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.
• Bring your own OAuth 2.0 app – connects to a private Google Cloud application you create.

Configuração de escopos

When you create a connection using Bring your own OAuth 2.0 app, you have the option to customize application scopes.

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.