Antes de chamar a API Mail Admin Quarantine, siga as etapas nesta página para ativar a API, encontrar os identificadores necessários para cada solicitação e conceder os privilégios de administrador necessários na sua conta do Google Workspace.
Pré-requisitos
- Uma conta do Google Workspace com o recurso de quarentena do administrador. Para saber mais, consulte Configurar e gerenciar quarentenas de e-mail.
- Um projeto do Google Cloud. Para criar um projeto, consulte Criar um projeto.
- Inscrição no Programa de prévia para desenvolvedores do Google Workspace. Seu projeto na nuvem precisa estar inscrito no programa antes de poder chamar a API Admin Quarantine.
- Acesso ao Google Admin Console como superadministrador, para conceder privilégios de administrador e autorizar a delegação em todo o domínio.
Ativar a API
Ative o mailadminquarantine.googleapis.com no projeto na nuvem que hospeda sua integração.
Console
No console do Google Cloud, ative a API Mail Admin Quarantine.
gcloud
Execute o comando a seguir, substituindo PROJECT_ID pelo ID do projeto na nuvem:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Encontre seu ID de cliente
Cada solicitação à API Admin Quarantine identifica sua conta do Google Workspace
com o nome de recurso customers/CUSTOMER_ID.
Para encontrar seu ID de cliente:
- Faça login no Admin Console como administrador.
- Acesse Conta > Configurações da conta > Perfil.
- Copie o ID de cliente.
Se o ID de cliente começar com C, remova o C e use o valor alfanumérico restante no nome do recurso, por exemplo, customers/01abc23de.
Não use o nome de domínio como ID de cliente.
Para mais informações, consulte Encontrar seu ID de cliente.
Conceder os privilégios de administrador necessários
A API Admin Quarantine aplica as mesmas verificações de privilégios de administrador que a quarentena do administrador no Admin Console. Cada solicitação é executada em nome de um administrador do Google Workspace, que precisa ter um dos seguintes privilégios do Gmail:
| Privilégio | O que ela permite |
|---|---|
| Acessar a quarentena de administrador | Acessar e gerenciar mensagens em todas as quarentenas, inclusive as quarentenas padrão. |
| Acessar quarentenas restritas | Acessar e gerenciar mensagens apenas em quarentenas associadas a grupos de que o administrador participa. |
Os superadministradores têm esses privilégios automaticamente. Para outros administradores, atribua uma função que inclua o privilégio:
- Faça login no Admin Console como superadministrador.
- Acesse Conta > Funções do administrador.
- Selecione uma função ou clique em Criar função.
- Na guia Privilégios, acesse Serviços > Gmail e selecione Acessar a quarentena de administrador ou Acessar quarentenas restritas.
- Atribua o papel à conta de administrador que sua integração personifica ao chamar a API.
Para mais detalhes sobre as funções de administrador delegado, consulte Delegar privilégios de administrador no Gmail e Definições de privilégios de administrador.
Se o administrador personificado não tiver o privilégio necessário, a API
vai retornar um erro 403 PERMISSION_DENIED.