Antes de llamar a la API de Mail Admin Quarantine, completa los pasos de esta página para habilitar la API, encontrar los identificadores que necesita cada solicitud y otorgar los privilegios de administrador necesarios en tu cuenta de Google Workspace.
Requisitos previos
- Una cuenta de Google Workspace con la función de cuarentena de administrador Para obtener más información, consulta Configura y administra cuarentenas de correo electrónico.
- Un proyecto de Google Cloud, Para crear un proyecto, consulta Crea un proyecto.
- Membresía en el Programa de versión preliminar para desarrolladores de Google Workspace Tu proyecto de Cloud debe estar inscrito en el programa para poder llamar a la API de Admin Quarantine.
- Acceso a la Consola del administrador de Google como administrador avanzado para otorgar privilegios de administrador y autorizar la delegación en todo el dominio
Habilita la API
Habilita mailadminquarantine.googleapis.com en el proyecto de Cloud que aloja tu
integración.
Console
En la consola de Google Cloud, habilita la API de Mail Admin Quarantine.
gcloud
Ejecuta el siguiente comando y reemplaza PROJECT_ID por el ID de tu proyecto de Cloud:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Encuentra tu ID de cliente
Cada solicitud a la API de Admin Quarantine identifica tu cuenta de Google Workspace
con el nombre del recurso customers/CUSTOMER_ID.
Para encontrar tu ID de cliente, sigue estos pasos:
- Accede a la Consola del administrador como administrador.
- Ve a Cuenta > Configuración de la cuenta > Perfil.
- Copia el ID de cliente.
Si el ID de cliente comienza con C, quita C y usa el valor alfanumérico restante en el nombre del recurso, por ejemplo, customers/01abc23de.
No uses tu nombre de dominio como ID de cliente.
Para obtener más información, consulta Encuentra tu ID de cliente.
Otorga los privilegios de administrador necesarios
La API de Admin Quarantine aplica las mismas verificaciones de privilegios de administrador que la cuarentena de administrador en la Consola del administrador. Cada solicitud se ejecuta en nombre de un administrador de Google Workspace, y ese administrador debe tener uno de los siguientes privilegios de Gmail:
| Privilege | Qué permite |
|---|---|
| Acceso a la cuarentena de administrador | Accede a los mensajes de todas las cuarentenas, incluida la predeterminada, y adminístralos. |
| Acceso a las cuarentenas restringidas | Acceder a los mensajes y administrarlos solo en las cuarentenas asociadas a los grupos a los que pertenece el administrador |
Los administradores avanzados tienen estos privilegios automáticamente. Para otros administradores, asigna un rol que incluya el privilegio:
- Accede a la Consola del administrador como administrador avanzado.
- Ve a Cuenta > Roles de administrador.
- Selecciona un rol existente o haz clic en Crear rol nuevo.
- En la pestaña Privilegios, ve a Servicios > Gmail y selecciona Acceder a la cuarentena del administrador o Acceder a las cuarentenas restringidas.
- Asigna el rol a la cuenta de administrador que tu integración suplanta cuando llama a la API.
Para obtener detalles sobre los roles de administrador delegado, consulta Cómo delegar privilegios de administrador en Gmail y Definiciones de privilegios de administrador.
Si el administrador que se suplanta no tiene el privilegio requerido, la API
devuelve un error 403 PERMISSION_DENIED.