Panoramica dell'API Admin Settings

L'API Admin Settings consente agli amministratori dei domini Google Workspace di recuperare e modificare le impostazioni dei propri domini sotto forma di feed dell'API di dati Google.

Queste impostazioni del dominio includono molte delle funzionalità disponibili nella Console di amministrazione di Google Workspace. Esempi di utilizzo di questa API includono la creazione di un pannello di controllo personalizzato o l'integrazione di domini Google Workspace in un ambiente legacy esistente.

L'API Admin Settings implementa il protocollo API di dati Google. L'API di dati di Google è conforme al modello di pubblicazione e modifica Atom Publishing Protocol (AtomPub). Le richieste HTTP AtomPub utilizzano l'approccio di progettazione Representational Set Transfer (RESTful) per i servizi web. Per ulteriori informazioni, consulta la Guida per gli sviluppatori di Google Data.

Pubblico

Questo documento è destinato agli sviluppatori che vogliono scrivere applicazioni client in grado di modificare e recuperare informazioni sui domini Google Workspace. Fornisce esempi delle interazioni di base dell'API Admin Settings utilizzando XML e HTTP non elaborati.

Questo documento presuppone che tu comprenda le idee generali alla base del protocollo Google Data API e che tu abbia familiarità con la Console di amministrazione Google Workspace. Per ulteriori informazioni sulla Console di amministrazione, vedi Utilizzare la Console di amministrazione.

Per iniziare

Creazione di un account

L'API Admin Settings è abilitata per gli account Google Workspace. Registrati per un account Google Workspace a scopo di test. Il servizio Impostazioni amministrazione utilizza gli Account Google, quindi se hai già un account su un dominio Google Workspace, non devi fare altro.

Informazioni sui tipi di feed dell'API Admin Settings

L'API Admin Settings ti consente di gestire queste categorie di impostazioni del dominio:

Impostazioni Single Sign-On

Il Single Sign-On (SSO) basato su SAML consente agli utenti di utilizzare lo stesso accesso e la stessa password sia per i servizi ospitati di Google Workspace sia per altri servizi che potresti ospitare all'interno della tua organizzazione. In particolare, quando si utilizza SSO, un'applicazione web ospitata, come Google Workspace, reindirizza gli utenti al provider di identità della tua organizzazione per autenticarli quando accedono. Per informazioni dettagliate, vedi Informazioni sull'SSO basato su SAML per Google Workspace.

La configurazione dell'SSO prevede l'inserimento delle informazioni necessarie per consentire al servizio Google Workspace di comunicare con il provider di identità che archivia le credenziali di accesso degli utenti, nonché la configurazione dei link a cui gli utenti devono essere indirizzati per accedere, uscire e modificare le password. L'API Admin Settings ti consente di aggiornare e recuperare queste impostazioni in modo programmatico. Google utilizza la chiave pubblica generata per verificare questa richiesta SSO con il tuo provider di identità e che la risposta SAML della chiave privata non sia stata modificata durante la trasmissione di rete.

Per un breve riepilogo specifico dell'API sull'utilizzo delle impostazioni SSO, recupera il certificato di chiave pubblica dal tuo provider di identità, registra la chiave pubblica con Google e configura le impostazioni di query SSO basate su SAML. Per i messaggi di errore, consulta la sezione Risolvere i problemi relativi al servizio SSO:

• Genera le chiavi: con il tuo IdP, genera una coppia di chiavi pubblica e privata utilizzando gli algoritmi DSA o RSA. La chiave pubblica si trova in un certificato in formato X.509. Per ulteriori informazioni sulle chiavi di firma Single Sign-On basate su SAML, vedi Generare chiavi e certificati per il servizio Single Sign-On di Google Workspace.
• Registrati con Google: utilizza le impostazioni Single Sign-On dell'API Admin Settings per registrare il certificato della chiave pubblica con Google.
• Configura le impostazioni SSO: utilizza le impostazioni Single Sign-On dell'API Admin Settings per configurare le impostazioni utilizzate per comunicare con i server del provider di identità del dominio.

Impostazioni di gateway e routing

Questo feed consente agli amministratori di dominio di controllare il routing delle email per i loro domini.

Le operazioni di routing email consentono agli amministratori di specificare le impostazioni di routing email a livello di dominio. Questa funzionalità è simile al routing email delle impostazioni di Gmail della Console di amministrazione. Per ulteriori informazioni, vedi Routing della posta e Configurazione della doppia consegna della funzionalità di routing della posta.

Esempio di richiesta e risposta XML dell'API Admin Settings

Questo documento fornisce esempi di codice di richieste e risposte di base dell'API Admin Settings utilizzando XML e HTTP non elaborati. Questo esempio di lingua predefinita del dominio mostra la sintassi XML e HTTP completa per il corpo di una voce di richiesta e risposta comune a ogni operazione:

Per modificare l'impostazione del gateway di posta in uscita del dominio, invia una richiesta HTTP PUT all'URL del feed del gateway:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

La richiesta XML AtomPub entry per la lingua predefinita del dominio PUT è:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

Ad eccezione delle proprietà e dei valori specifici dell'operazione, gli elementi atom:property rappresentano una singola coppia chiave-valore contenente informazioni su una proprietà che vuoi recuperare o aggiornare. Questi sono comuni a tutti i corpi delle richieste dell'API Admin Settings.

L'elemento entry della risposta della lingua predefinita del dominio restituisce le proprietà smartHost e smtpMode insieme alla sintassi XML comune a tutti i corpi delle risposte dell'API Admin Settings:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

Gestire le impostazioni Single Sign-On

La funzionalità Single Sign-On (SSO) di Google Workspace consente agli utenti di accedere a più servizi inserendo le credenziali di accesso una sola volta. Questa password viene memorizzata dal provider di identità del dominio, non da Google Workspace. Per saperne di più, consulta la pagina SSO del Centro assistenza. Le sezioni seguenti mostrano il formato XML utilizzato per le impostazioni Single Sign-On.

Recupero delle impostazioni Single Sign-On

Per recuperare le impostazioni Single Sign-On, invia una richiesta HTTP GET all'URL del feed generale SSO e includi un'intestazione Authorization come descritto in Autenticazione al servizio Impostazioni amministrative. Per i messaggi di errore, consulta Risolvere i problemi relativi al Single Sign-On:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta riuscita restituisce un codice di stato HTTP 200 OK, insieme a un feed AtomPub con le impostazioni SSO del dominio.

L'XML della risposta GET restituisce le proprietà samlSignonUri, samlLogoutUri, changePasswordUri, enableSSO, ssoWhitelist e useDomainSpecificIssuer:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

Le proprietà includono:

samlSignonUri

L'URL del provider di identità a cui Google Workspace invia la richiesta SAML per l'autenticazione dell'utente.

samlLogoutUri

L'indirizzo a cui verranno indirizzati gli utenti quando escono dall'applicazione web.

changePasswordUri

L'indirizzo a cui verranno indirizzati gli utenti quando vogliono modificare la password SSO per l'applicazione web.

enableSSO

Attiva il servizio SSO basato su SAML per questo dominio. Se hai configurato in precedenza le impostazioni SSO e successivamente hai impostato enableSSO su enableSSO=false, le impostazioni che hai inserito in precedenza vengono comunque salvate.

ssoWhitelist

Un ssoWhitelist è un indirizzo IP maschera di rete in formato CIDR (Classless Inter-Domain Routing). La ssoWhitelist determina quali utenti accedono utilizzando SSO e quali utenti accedono utilizzando la pagina di autenticazione dell'account Google Workspace. Se non è specificata alcuna maschera, tutti gli utenti accederanno utilizzando il servizio SSO. Per saperne di più, consulta Come funzionano le maschere di rete.

useDomainSpecificIssuer

Nella richiesta SAML al provider di identità può essere utilizzato un emittente specifico per il dominio. Sebbene non sia necessaria per la maggior parte delle implementazioni SSO, questa funzionalità è utile nelle grandi aziende che utilizzano un unico provider di identità per autenticare un'intera organizzazione con più sottodomini. Specificare l'emittente del dominio determina il sottodominio da associare alla richiesta. Per saperne di più, vedi Come funziona l'elemento Issuer nella richiesta SAML?

Se la richiesta non va a buon fine per qualche motivo, viene restituito un codice di stato diverso. Per ulteriori informazioni sui codici di stato dell'API Google Data, consulta Codici di stato HTTP.

Aggiornamento delle impostazioni Single Sign-On

Per aggiornare le impostazioni SSO di un dominio, recupera prima le impostazioni SSO utilizzando l'operazione Recupero delle impostazioni Single Sign-On, modificale e poi invia una richiesta PUT all'URL del feed SSO. Assicurati che il valore di <id> nella voce aggiornata corrisponda esattamente a quello di <id> della voce esistente. Includi un'intestazione Authorization come descritto in Autenticazione al servizio API Admin Settings. Per i messaggi di errore, vedi Risoluzione dei problemi relativi al Single Sign-On (SSO).

Quando aggiorni le impostazioni Single Sign-On, invia un comando HTTP PUT all'URL del feed generale SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

Il corpo XML della richiesta PUT è:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

Una risposta riuscita restituisce un codice di stato HTTP 200 OK, insieme a un feed AtomPub con le impostazioni SSO.

Il codice XML della risposta PUT è:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

Se la richiesta non va a buon fine per qualche motivo, viene restituito un codice di stato diverso. Per ulteriori informazioni sui codici di stato dell'API Google Data, consulta Codici di stato HTTP.

Le modifiche alle impostazioni del Single Sign-On non sono consentite quando il cliente di destinazione ha attivato l'approvazione da più parti per le azioni sensibili. Le richieste non andranno a buon fine e verranno restituiti gli errori errorCode="1811" e reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

Recupero della chiave di firma Single Sign-On

Per recuperare la chiave di firma Single Sign-On, invia un GET HTTP all'URL del feed della chiave di firma SSO e includi un'intestazione Authorization come descritto in Autenticazione al servizio Impostazioni amministrazione. Per i messaggi di errore, consulta Risolvere i problemi relativi al Single Sign-On:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta riuscita restituisce un codice di stato HTTP 200 OK, insieme a un feed AtomPub con la chiave di firma.

Il codice XML della risposta GET restituisce la proprietà signingKey:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

Se la richiesta non va a buon fine per qualche motivo, viene restituito un codice di stato diverso. Per ulteriori informazioni sui codici di stato dell'API Google Data, consulta Codici di stato HTTP.

Aggiornamento della chiave di firma Single Sign-On

Per aggiornare la chiave di firma SSO di un dominio, recuperala prima utilizzando l'operazione Recupero della chiave di firma Single Sign-On, modificala e poi invia una richiesta PUT all'URL del feed della chiave di firma SSO. Assicurati che il valore di <id> nella voce aggiornata corrisponda esattamente a quello di <id> della voce esistente. Per ulteriori informazioni sulle chiavi di firma Single Sign-On basate su SAML, vedi Generare chiavi e certificati per il servizio Single Sign-On di Google Workspace.

Quando aggiorni la chiave di firma Single Sign-On, invia un HTTP PUT all'URL del feed della chiave di firma SSO:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

Il codice XML della richiesta PUT è:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

Le modifiche alle impostazioni del Single Sign-On non sono consentite quando il cliente di destinazione ha attivato l'approvazione da più parti per le azioni sensibili. Le richieste non andranno a buon fine e verranno restituiti gli errori errorCode="1811" e reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval".

Gestione del gateway di posta e del routing

La sezione del gateway email in uscita mostra come l'API Admin Settings supporta il routing in uscita della posta degli utenti del tuo dominio. La sezione Routing email mostra come indirizzare i messaggi a un altro server di posta.

Recupero delle impostazioni del gateway di posta in uscita

Per recuperare le impostazioni del gateway di posta in uscita, invia un comando HTTP GET all'URL del feed del gateway e includi un'intestazione Authorization come descritto in Autenticazione al servizio Impostazioni amministrative:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

Questa operazione non ha parametri nel corpo della richiesta.

Una risposta riuscita restituisce un codice di stato HTTP 200 OK, insieme a un feed AtomPub con le informazioni sullo stato del gateway email.

La risposta GET restituisce le proprietà smartHost e smtpMode. Per ulteriori informazioni su queste proprietà, consulta Aggiornamento delle impostazioni del gateway della posta in uscita.

Un esempio di possibile risposta è:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

Se la richiesta non va a buon fine per qualche motivo, viene restituito un codice di stato diverso. Per ulteriori informazioni sui codici di stato dell'API Google Data, consulta Codici di stato HTTP.

Aggiornamento delle impostazioni del gateway email in uscita

Per aggiornare l'impostazione del gateway di posta in uscita di un dominio, invia una richiesta HTTP PUT all'URL del feed del gateway:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

Il codice XML della richiesta PUT è:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

Le proprietà della richiesta sono:

smartHost

L'indirizzo IP o il nome host del server SMTP. Google Workspace indirizza la posta in uscita a questo server.

smtpMode

Il valore predefinito è SMTP. Un altro valore, SMTP_TLS, protegge una connessione con TLS durante la consegna del messaggio.

Una risposta riuscita restituisce un codice di stato HTTP 200 OK, insieme al feed AtomPub con lo stato delle impostazioni del gateway email.

Se la richiesta non va a buon fine per qualche motivo, viene restituito un codice di stato diverso. Per ulteriori informazioni sui codici di stato dell'API Google Data, consulta Codici di stato HTTP.

Gestire le impostazioni di routing email

Innanzitutto, crea una richiesta XML:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

Le proprietà della richiesta sono:

routeDestination

Questa destinazione è il nome host o l'indirizzo IP del server di posta SMTP-In a cui viene indirizzata l'email. Il nome host o l'indirizzo IP deve essere risolto per Google. Per maggiori dettagli sulla risoluzione dei nomi host di posta, vedi Provare Google Workspace con il routing email.

routeRewriteTo

Se è true, il campo to: della busta SMTP del messaggio viene modificato con il nome host di destinazione (user@hostname di destinazione) e il messaggio viene recapitato a questo indirizzo utente sul server di posta di destinazione. Se false, l'email viene recapitata all'indirizzo email to: del messaggio originale (user@hostname originale) sul server di posta di destinazione. Questa impostazione è simile a quella "Modifica busta SMTP" della Console di amministrazione. Per ulteriori informazioni, vedi Impostazioni del dominio per il routing della posta.

routeEnabled

Se true, la funzionalità di routing email è attivata. Se false, la funzionalità è disattivata.

bounceNotifications

Se true, Google Workspace è abilitato a inviare notifiche di mancato recapito al mittente quando un recapito non va a buon fine.

accountHandling

Questa impostazione determina in che modo i diversi tipi di utenti del dominio sono interessati dal routing email:

• allAccounts: invia tutte le email a questa destinazione.
• provisionedAccounts -- Deliver mail to this destination if the user exists in Google Workspace.
• unknownAccounts: invia la posta a questa destinazione se l'utente non esiste in Google Workspace. Questa impostazione è simile a "Email di notifica per" della Console di amministrazione. Per ulteriori informazioni sui prerequisiti e su come utilizzare il routing della posta, vedi Impostazioni del dominio per il routing della posta. ~ Per pubblicare questa richiesta, invia una richiesta HTTP POST all'URL del feed di routing email e includi un'intestazione Authorization come descritto in Autenticazione al servizio Impostazioni amministrative:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

Una risposta riuscita restituisce un codice di stato HTTP 200 OK, insieme a un feed AtomPub con le informazioni sull'archivio.

Se la richiesta non va a buon fine per qualche motivo, viene restituito un codice di stato diverso. Per ulteriori informazioni sui codici di stato dell'API Google Data, consulta Codici di stato HTTP.

Ritiro degli endpoint il 31 ottobre 2018

Abbiamo ritirato i seguenti endpoint nell'ambito di questo annuncio. Sono state ritirate il 31 ottobre 2018 e non sono più disponibili.

• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
• https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx