Mit der Admin Settings API können Administratoren von Google Workspace-Domains die Einstellungen ihrer Domains in Form von Google Data API-Feeds abrufen und ändern.
Diese Domaineinstellungen umfassen viele der Funktionen, die in der Admin-Konsole von Google Workspace verfügbar sind. Diese API wird beispielsweise zum Erstellen eines benutzerdefinierten Steuerfelds oder zum Einbinden von Google Workspace-Domains in eine bestehende Legacy-Umgebung verwendet.
Mit der Admin Settings API wird das Google Data API-Protokoll implementiert. Das Google Data API entspricht dem Veröffentlichungs- und Bearbeitungsmodell des Atom Publishing Protocol (AtomPub). Die AtomPub-HTTP-Anfragen verwenden für Webdienste den RESTful-Designansatz (Repräsentational Set Transfer). Weitere Informationen finden Sie im Datenentwicklerhandbuch von Google.
Zielgruppe
Dieses Dokument richtet sich an Entwickler, die Clientanwendungen schreiben, mit denen Informationen zu Google Workspace-Domains geändert und abgerufen werden können. Sie enthält Beispiele für die grundlegenden Interaktionen mit der Admin Settings API unter Verwendung von XML- und HTTP-Rohdaten.
In diesem Dokument wird davon ausgegangen, dass Sie die allgemeinen Konzepte des Google Data API-Protokolls kennen und mit der Admin-Konsole von Google Workspace vertraut sind. Weitere Informationen zur Admin-Konsole finden Sie im Hilfeartikel Admin-Konsole verwenden.
Erste Schritte
Konto erstellen
Die Admin Settings API ist für Google Workspace-Konten aktiviert. Registrieren Sie sich für ein Google Workspace-Konto, um Testzwecke zu nutzen. Für die Administratoreinstellungen werden Google-Konten verwendet. Wenn Sie also bereits ein Konto in einer Google Workspace-Domain haben, müssen Sie nichts weiter tun.
Feedtypen der Admin Settings API
Mit der Admin Settings API können Sie die folgenden Kategorien von Domain-Einstellungen verwalten:
- Einstellungen für die Einmalanmeldung (SSO)
Die SAML-basierte Einmalanmeldung (SSO) ermöglicht es Nutzern, denselben Log-in und dasselbe Passwort sowohl für von Google Workspace gehostete Dienste als auch für andere Dienste zu verwenden, die Sie möglicherweise in Ihrer Organisation hosten. Insbesondere bei Verwendung der Einmalanmeldung (SSO) werden Nutzer von einer gehosteten Webanwendung wie Google Workspace an den Identitätsanbieter Ihrer Organisation weitergeleitet, um sie bei der Anmeldung zu authentifizieren. Weitere Informationen finden Sie im Hilfeartikel SAML-basierte Einmalanmeldung (SSO) für Google Workspace.
Beim Konfigurieren der Einmalanmeldung (SSO) müssen Sie die erforderlichen Informationen eingeben, damit der Google Workspace-Dienst mit dem Identitätsanbieter kommunizieren kann, der die Daten Ihrer Nutzer speichert. sowie die Links einrichten, über die Nutzer sich an- und abmelden und ihre Passwörter ändern können. Mit der Admin Settings API können Sie diese Einstellungen programmatisch aktualisieren und abrufen. Google verwendet Ihren generierten öffentlichen Schlüssel, um diese SSO-Anfrage bei Ihrem Identitätsanbieter zu verifizieren und zu bestätigen, dass die SAML-Antwort des privaten Schlüssels während der Netzwerkübertragung nicht geändert wurde.
Eine kurze API-spezifische Zusammenfassung der Verwendung der SSO-Einstellungen erhalten Sie, wenn Sie Ihr Public-Key-Zertifikat von Ihrem Identitätsanbieter anfordern, den öffentlichen Schlüssel bei Google registrieren und Ihre SAML-basierten SSO-Abfrageeinstellungen einrichten. Informationen zu Fehlermeldungen finden Sie unter Fehlerbehebung bei der Einmalanmeldung (SSO):- Schlüssel generieren: Generieren Sie zusammen mit Ihrem Identitätsanbieter mithilfe des DSA- oder RSA-Algorithmus eine Reihe öffentlicher und privater Schlüssel. Der öffentliche Schlüssel befindet sich in einem Zertifikat im X.509-Format. Weitere Informationen zu SAML-basierten Signaturschlüsseln der Einmalanmeldung (SSO) finden Sie im Hilfeartikel Schlüssel und Zertifikate für den Google Workspace-Dienst zur Einmalanmeldung (SSO) generieren.
- Bei Google registrieren: Verwenden Sie die Einstellungen für die Einmalanmeldung (SSO) der Admin Settings API, um Ihr Public-Key-Zertifikat bei Google zu registrieren.
- SSO-Einstellungen einrichten: Verwenden Sie die Einstellungen für die Einmalanmeldung (SSO) der Admin Settings API, um die Einstellungen für die Kommunikation mit den Servern der Domain zu konfigurieren.
- Gateway- und Routingeinstellungen
Mit diesem Feed können Domainadministratoren die E-Mail-Weiterleitung für ihre Domains steuern.
Mit den E-Mail-Weiterleitungsvorgängen können Administratoren die Einstellungen für die E-Mail-Weiterleitung auf Domainebene festlegen. Diese Funktion ähnelt der E-Mail-Weiterleitungsfunktion in den Gmail-Einstellungen der Admin-Konsole. Weitere Informationen finden Sie unter E-Mail-Weiterleitung und Konfiguration der doppelten Zustellung von E-Mail-Weiterleitungen.
Beispiel einer Admin Settings API-XML-Anfrage und -Antwort
Dieses Dokument enthält Codebeispiele für grundlegende Admin Settings API-Anfragen und -Antworten mit XML und HTTP im Rohformat. Dieses Beispiel für eine Domain-Standardsprache zeigt die vollständige XML- und HTTP-Syntax für den Textkörper eines Anfrage- und Antworteintrags, der für jeden Vorgang gemeinsam ist:
Um die Einstellung für das Ausgangs-E-Mail-Gateway der Domain zu ändern, senden Sie eine HTTP-PUT
an die Gateway-Feed-URL:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway
Die AtomPubentry
-XML-Anfrage der Domain-Standardsprache PUT
lautet:
<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>
Mit Ausnahme der vorgangsspezifischen Eigenschaften und Werte stellen die atom:property
-Elemente ein einzelnes Schlüssel/Wert-Paar dar, das Informationen zu einer Eigenschaft enthält, die Sie abrufen oder aktualisieren möchten. Diese gelten für alle Anfragetexte der Admin Settings API.
Das Antwortelement entry
der Domain-Standardsprache gibt die Eigenschaften smartHost
und smtpMode
zusammen mit der XML-Syntax zurück, die für alle Antworttexte der Admin Settings API gilt:
<?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>
Einstellungen für die Einmalanmeldung (SSO) verwalten
Mit der Einmalanmeldung (SSO) von Google Workspace können sich Nutzer in mehreren Diensten anmelden und müssen dabei nur einmal ihre Anmeldedaten eingeben. Dieses Passwort wird vom Identitätsanbieter der Domain gespeichert, nicht von Google Workspace. Weitere Informationen finden Sie auf der Hilfeseite zur Einmalanmeldung (SSO). In den folgenden Abschnitten wird das XML-Format beschrieben, das für die Einstellungen für die Einmalanmeldung (SSO) verwendet wird.
Einstellungen für die Einmalanmeldung (SSO) abrufen
Zum Abrufen der Einstellungen für die Einmalanmeldung (SSO) senden Sie ein HTTP-GET
-Objekt an die allgemeine SSO-Feed-URL und fügen einen Authorization
-Header ein, wie unter Authentifizierung beim Administratoreinstellungsdienst beschrieben. Informationen zu Fehlermeldungen finden Sie unter Fehlerbehebung bei der Einmalanmeldung (SSO):
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general
Dieser Vorgang enthält keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 OK
zusammen mit einem AtomPub-Feed mit den SSO-Einstellungen der Domain zurückgegeben.
Die GET-Antwort-XML gibt die Attribute samlSignonUri
, samlLogoutUri
, changePasswordUri
, enableSSO
, ssoWhitelist
und useDomainSpecificIssuer
zurück:
<?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>
Zu den Eigenschaften gehören:
- samlSignonUri
- Die URL des Identitätsanbieters, an die Google Workspace die SAML-Anfrage zur Nutzerauthentifizierung sendet.
- samlLogoutUri
- Die E-Mail-Adresse, an die Nutzer gesendet werden, wenn sie sich von der Webanwendung abmelden.
- changePasswordUri
- Die Adresse, an die Nutzer gesendet werden, wenn sie ihr SSO-Passwort für die Webanwendung ändern möchten.
- enableSSO
- Aktiviert die SAML-basierte SSO für diese Domain. Wenn Sie zuvor SSO-Einstellungen konfiguriert haben und
enableSSO
anschließend aufenableSSO=false
gesetzt haben, bleiben die zuvor eingegebenen Einstellungen gespeichert. - ssoWhitelist
- Ein ssoWhitelist ist eine Netzwerkmasken-IP-Adresse im CIDR-Format (Classless Inter-Domain Routing). Mit ssoWhitelist wird festgelegt, welche Nutzer sich über SSO anmelden und welche Nutzer sich über die Authentifizierungsseite des Google Workspace-Kontos anmelden. Wenn keine Masken angegeben sind, melden sich alle Nutzer über SSO an. Weitere Informationen finden Sie unter Funktionsweise von Netzwerkmasken.
- useDomainSpecificIssuer
- In der SAML-Anfrage an den Identitätsanbieter kann ein domainspezifischer Aussteller verwendet werden. Obwohl diese Funktion für die meisten SSO-Bereitstellungen nicht erforderlich ist, ist sie in großen Unternehmen nützlich, die einen einzigen Identitätsanbieter zur Authentifizierung einer gesamten Organisation mit mehreren Subdomains verwenden. Wird der jeweilige Domainaussteller angegeben, wird festgelegt, welche Subdomain mit der Anfrage verknüpft wird. Weitere Informationen finden Sie unter Wie funktioniert das Ausstellerelement in der SAML-Anfrage?
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Google Data API-Statuscodes finden Sie unter HTTP-Statuscodes.
Einstellungen für die Einmalanmeldung (SSO) aktualisieren
Um die SSO-Einstellungen einer Domain zu aktualisieren, rufen Sie zuerst die SSO-Einstellungen mit dem Vorgang Abrufen der Einstellungen für die Einmalanmeldung (SSO) ab, ändern Sie sie und senden Sie dann eine PUT
-Anfrage an die SSO-Feed-URL. Achten Sie darauf, dass der <id>
-Wert in Ihrem aktualisierten Eintrag genau mit dem <id>
des vorhandenen Eintrags übereinstimmt. Fügen Sie einen Authorization
-Header ein, wie unter Beim Admin Settings API-Dienst authentifizieren beschrieben. Informationen zu Fehlermeldungen finden Sie unter Fehlerbehebung bei der Einmalanmeldung (SSO).
Wenn Sie die Einstellungen für die Einmalanmeldung (SSO) aktualisieren, senden Sie eine HTTP PUT-Anfrage an die allgemeine SSO-Feed-URL:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general
Der XML-Text der PUT
-Anfrage lautet:
<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>
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200 OK
zusammen mit einem AtomPub-Feed mit den SSO-Einstellungen zurückgegeben.
Die Antwort-XML für PUT
lautet:
<?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>
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Google Data API-Statuscodes finden Sie unter HTTP-Statuscodes.
Änderungen an den Einstellungen für die Einmalanmeldung (SSO) sind nicht zulässig, wenn der Zielkunde die Genehmigung durch mehrere Parteien für vertrauliche Aktionen aktiviert hat. Anfragen schlagen mit errorCode="1811"
und reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"
fehl.
Sign-On-Signaturschlüssel für die Einmalanmeldung (SSO) abrufen
Senden Sie zum Abrufen des Signaturschlüssels der Einmalanmeldung (SSO) ein HTTP-GET
-Objekt an die Feed-URL des SSO-Signaturschlüssels und fügen Sie einen Authorization
-Header ein, wie unter Authentifizierung beim Dienst für Administratoreinstellungen beschrieben. Informationen zu Fehlermeldungen finden Sie unter Fehlerbehebung bei der Einmalanmeldung (SSO):
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey
Dieser Vorgang enthält keine Parameter im Anfragetext.
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200 OK
zusammen mit einem AtomPub-Feed mit dem Signaturschlüssel zurückgegeben.
Die Antwort-XML GET
gibt das Attribut signingKey
zurück:
<?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>
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Google Data API-Statuscodes finden Sie unter HTTP-Statuscodes.
Signaturschlüssel für die Einmalanmeldung (SSO) aktualisieren
Um den SSO-Signaturschlüssel einer Domain zu aktualisieren, rufen Sie zuerst den Signaturschlüssel mit dem Vorgang Single Sign-On-Signaturschlüssel abrufen ab, ändern Sie ihn und senden Sie dann eine PUT
-Anfrage an die Feed-URL des SSO-Signaturschlüssels. Achten Sie darauf, dass der <id>
-Wert in Ihrem aktualisierten Eintrag genau mit dem <id>
des vorhandenen Eintrags übereinstimmt. Weitere Informationen zu SAML-basierten Signaturschlüsseln der Einmalanmeldung (SSO) finden Sie im Hilfeartikel Schlüssel und Zertifikate für den Google Workspace-Dienst zur Einmalanmeldung (SSO) generieren.
Wenn Sie den Signaturschlüssel der Einmalanmeldung (SSO) aktualisieren, senden Sie eine HTTP-PUT
-Anfrage an die Feed-URL des SSO-Signaturschlüssels:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey
Die Anfrage-XML für PUT
lautet:
<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>
Änderungen an den Einstellungen für die Einmalanmeldung (SSO) sind nicht zulässig, wenn der Zielkunde die Genehmigung durch mehrere Parteien für vertrauliche Aktionen aktiviert hat. Anfragen schlagen mit errorCode="1811"
und reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"
fehl.
E-Mail-Gateway und -Routing verwalten
Im Abschnitt "Gateway für ausgehende E-Mails" wird gezeigt, wie die Admin Settings API die ausgehende Weiterleitung von E-Mails von Nutzern in Ihrer Domain unterstützt. Im Abschnitt zur E-Mail-Weiterleitung wird gezeigt, wie Nachrichten an einen anderen E-Mail-Server weitergeleitet werden.
Einstellungen für das Gateway für ausgehende E-Mails werden abgerufen
Zum Abrufen der Gateway-Einstellungen für ausgehende E-Mails senden Sie ein HTTP-GET
-Objekt an die Gateway-Feed-URL und fügen einen Authorization
-Header ein, wie unter Authentifizierung beim Dienst für Administratoreinstellungen beschrieben:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway
Dieser Vorgang enthält keine Parameter im Anfragetext.
Eine erfolgreiche Antwort gibt den Statuscode "HTTP 200 OK" sowie einen AtomPub-Feed mit den Statusinformationen des E-Mail-Gateways zurück.
Die GET
-Antwort gibt die Attribute smartHost
und smtpMode
zurück. Weitere Informationen zu diesen Eigenschaften finden Sie unter Einstellungen für das Gateway für ausgehende E-Mails aktualisieren.
Ein Beispiel für eine mögliche Antwort ist:
<?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>
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Google Data API-Statuscodes finden Sie unter HTTP-Statuscodes.
Einstellungen für das Gateway für ausgehende E-Mails aktualisieren
Um die Einstellung für das Ausgangs-Gateway einer Domain zu aktualisieren, senden Sie eine HTTP-PUT
-Anfrage an die Gateway-Feed-URL:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway
Die Anfrage-XML für PUT
lautet:
<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>
Die Anfrageeigenschaften sind:
- smartHost
- Das kann die IP-Adresse oder der Hostname Ihres SMTP-Servers sein. Google Workspace leitet ausgehende E-Mails an diesen Server weiter.
- smtpMode
- Der Standardwert ist SMTP. Ein anderer Wert, SMTP_TLS, sichert bei der Zustellung der Nachricht eine Verbindung mit TLS.
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200 OK
zusammen mit dem AtomPub-Feed mit dem Status der E-Mail-Gateway-Einstellungen zurückgegeben.
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Google Data API-Statuscodes finden Sie unter HTTP-Statuscodes.
Einstellungen für die E-Mail-Weiterleitung verwalten
Erstellen Sie zuerst eine XML-Anfrage:
<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>
Die Anfrageeigenschaften sind:
- routeDestination
- Das Ziel ist der Hostname oder die IP-Adresse des SMTP-In-E-Mail-Servers, an den die E-Mail weitergeleitet wird. Der Hostname oder die IP-Adresse muss für Google aufgelöst werden. Weitere Informationen zum Zuordnen von E-Mail-Hostnamen finden Sie unter Pilotprojekt für Google Workspace mit E-Mail-Weiterleitung.
- routeRewriteTo
- Ist dieser Wert auf „true“ gesetzt, wird das Feld
to:
des SMTP-Umschlags der Nachricht in den Hostnamen des Ziels (Nutzer@Ziel-Hostname) geändert und die Nachricht wird an die Adresse des Ziel-E-Mail-Servers zugestellt. Wennfalse
, wird die E-Mail an dieto:
-E-Mail-Adresse der ursprünglichen Nachricht (nutzer@ursprünglicher Hostname) auf dem Ziel-E-Mail-Server zugestellt. Dies ähnelt der Option "SMTP-Umschlag ändern" in der Admin-Konsole. Einstellung. Weitere Informationen finden Sie unter Domaineinstellungen für die E-Mail-Weiterleitung. - routeEnabled
- Wenn
true
festgelegt ist, ist die Funktion für die E-Mail-Weiterleitung aktiviert. Beifalse
ist die Funktion deaktiviert. - bounceNotifications
- Wenn
true
festgelegt ist, wird in Google Workspace eine Unzustellbarkeitsnachricht an den Absender gesendet, wenn eine Zustellung fehlschlägt. - accountHandling
Mit dieser Einstellung legen Sie fest, wie verschiedene Arten von Nutzern in der Domain von der E-Mail-Weiterleitung betroffen sind:
allAccounts
- Alle E-Mails an dieses Ziel zustellen.provisionedAccounts
: E-Mails an dieses Ziel zustellen, wenn der Nutzer in Google Workspace vorhanden ist.unknownAccounts
: E-Mails an dieses Ziel zustellen, wenn der Nutzer nicht in Google Workspace vorhanden ist. Dies ähnelt der "E-Mail-Adresse für die Zustellung von" in der Admin-Konsole. Einstellung. Weitere Informationen zu den Voraussetzungen und zur Verwendung der E-Mail-Weiterleitung finden Sie unter Domaineinstellungen für die E-Mail-Weiterleitung. ~ Um diese Anfrage zu veröffentlichen, senden Sie ein HTTP-POST
-Objekt an die URL des E-Mail-Routingfeeds und fügen Sie einenAuthorization
-Header ein, wie unter Authentifizierung beim Dienst für Administratoreinstellungen beschrieben:
https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting
Eine erfolgreiche Antwort gibt den HTTP-Statuscode 200 OK
zusammen mit einem AtomPub-Feed mit den Archivinformationen zurück.
Wenn Ihre Anfrage aus irgendeinem Grund fehlschlägt, wird ein anderer Statuscode zurückgegeben. Weitere Informationen zu den Google Data API-Statuscodes finden Sie unter HTTP-Statuscodes.
Endpoints wird am 31. Oktober 2018 eingestellt
Die folgenden Endpunkte wurden im Rahmen dieser Ankündigung eingestellt. Sie wurden am 31. Oktober 2018 eingestellt und sind nicht mehr verfügbar.
- 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