Prima di chiamare l'API Mail Admin Quarantine, completa i passaggi descritti in questa pagina per attivare l'API, trovare gli identificatori necessari per ogni richiesta e concedere i privilegi di amministratore richiesti nel tuo account Google Workspace.
Prerequisiti
- Un account Google Workspace con la funzionalità di quarantena amministrativa. Per saperne di più, vedi Configurare e gestire le quarantene email.
- Un progetto Google Cloud. Per creare un progetto, consulta Crea un progetto.
- Iscrizione al programma Anteprima per gli sviluppatori di Google Workspace. Il tuo progetto cloud deve essere registrato nel programma prima di poter chiamare l'API Admin Quarantine.
- Accesso alla Console di amministrazione Google come super amministratore per concedere privilegi amministrativi e autorizzare la delega a livello di dominio.
Abilita l'API
Abilita mailadminquarantine.googleapis.com nel progetto cloud che ospita la tua integrazione.
Console
Nella console Google Cloud, abilita l'API Mail Admin Quarantine.
gcloud
Esegui questo comando, sostituendo PROJECT_ID con l'ID del tuo progetto Cloud:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Trova il tuo ID cliente
Ogni richiesta all'API Admin Quarantine identifica il tuo account Google Workspace con il nome della risorsa customers/CUSTOMER_ID.
Per trovare il tuo ID cliente:
- Accedi alla Console di amministrazione come amministratore.
- Vai ad Account > Impostazioni account > Profilo.
- Copia l'ID cliente.
Se l'ID cliente inizia con C, rimuovi C e utilizza il valore alfanumerico rimanente nel nome della risorsa, ad esempio customers/01abc23de.
Non utilizzare il nome di dominio come ID cliente.
Per saperne di più, consulta Trova il tuo ID cliente.
Concedi i privilegi amministrativi richiesti
L'API Admin Quarantine applica gli stessi controlli dei privilegi di amministratore della quarantena amministrativa nella Console di amministrazione. Ogni richiesta viene eseguita per conto di un amministratore di Google Workspace, che deve disporre di uno dei seguenti privilegi di Gmail:
| Privilege | Cosa consente |
|---|---|
| Accesso alla quarantena amministrativa | Accedere ai messaggi in tutte le quarantene, inclusa quella predefinita, e gestirli. |
| Accesso a quarantene limitate | Accedere e gestire i messaggi solo nelle quarantene associate ai gruppi di cui fa parte l'amministratore. |
I super amministratori dispongono di questi privilegi automaticamente. Per gli altri amministratori, assegna un ruolo che includa il privilegio:
- Accedi alla Console di amministrazione come super amministratore.
- Vai ad Account > Ruoli amministratore.
- Seleziona un ruolo esistente o fai clic su Crea nuovo ruolo.
- Nella scheda Privilegi, vai a Servizi > Gmail e seleziona Accesso alla quarantena amministrativa o Accesso a quarantene limitate.
- Assegna il ruolo all'account amministratore di cui l'integrazione assume l'identità quando chiama l'API.
Per maggiori dettagli sui ruoli di amministratore delegato, vedi Delegare i privilegi di amministratore in Gmail e Definizioni dei privilegi di amministratore.
Se l'amministratore di cui viene eseguita la simulazione non dispone del privilegio richiesto, l'API restituisce un errore 403 PERMISSION_DENIED.