Meta tags:

Headings (most frequently used words):

settings, on, single, sign, admin, api, email, gateway, the, retrieve, update, and, manage, an, signing, key, outbound, overview, stay, organized, with, collections, save, categorize, content, based, your, preferences, audience, get, started, endpoints, sunset, oct, 31, 2018, create, account, about, feed, types, sample, of, xml, request, response, google, workspace, for, developers, tools, connect,

Text of the page (most frequently used words):
the (143), google (116), apps (84), settings (63), for (58), api (52), domain (49), http (48), sso (45), and (44), com (44), admin (40), #workspace (33), value (33), property (32), your (31), sign (31), email (29), name (28), apis (26), with (26), request (25), atom (25), entry (25), single (25), feeds (23), status (23), gateway (23), information (22), https (22), domainname (22), manage (20), see (20), xml (20), console (18), overview (18), this (18), xmlns (18), www (18), key (18), more (17), retrieve (17), users (17), send (16), feed (16), response (15), update (15), code (14), get (14), data (13), you (13), signing (13), using (13), about (12), example (12), troubleshoot (12), codes (11), outbound (11), put (11), identity (11), url (10), saml (10), provider (10), service (9), are (9), general (9), returns (9), smtp (9), when (9), org (9), 2005 (9), schemas (9), 2006 (9), use (9), routing (9), that (9), client (9), choose (9), scopes (9), script (8), thumb (8), atompub (8), based (8), set (8), shared (8), install (8), libraries (8), all (7), cloud (7), developer (7), support (7), reason (7), note (7), smtpmode (7), smarthost (7), properties (7), operation (7), include (7), authorization (7), requests (7), enablesso (7), ssowhitelist (7), account (7), chrome (6), out (6), updated (6), accountinformation (6), some (6), along (6), have (6), signingkey (6), keys (6), false (6), domains (6), public (6), drive (6), contacts (6), groups (6), twitter (5), blog (5), developers (5), down (5), java (5), fails (5), different (5), returned (5), user (5), sent (5), successful (5), 200 (5), transfer (5), address (5), feature (5), version (5), encoding (5), utf (5), these (5), has (5), body (5), how (5), customer (5), will (5), error (5), samlsignonuri (5), samllogouturi (5), changepassworduri (5), usedomainspecificissuer (5), authentication (5), their (5), password (5), web (5), application (5), create (5), started (5), search (5), notifications (5), devices (5), español (4), products (4), youtube (4), license (4), they (4), from (4), mail (4), default (4), header (4), described (4), authenticating (4), messages (4), troubleshooting (4), specific (4), organization (4), which (4), change (4), lets (4), services (4), configure (4), chat (4), contact (4), newsletter (3), explorer (3), dashboard (3), tools (3), release (3), notes (3), codelabs (3), samples (3), other (3), content (3), page (3), edition (3), changes (3), setting (3), parameters (3), enabled (3), first (3), modify (3), existing (3), signon (3), logout (3), changepassword (3), issuer (3), used (3), not (3), network (3), want (3), login (3), language (3), common (3), document (3), administrators (3), gmail (3), register (3), certificate (3), uses (3), accounts (3), protocol (3), guides (3), home (3), docs (3), batch (3), push (3), enterprise (3), browsers (3), errors (3), subscription (3), customers (3), python (3), node (3), javascript (3), quickstarts (3), prerequisites (3), resources (3), 한국어 (2), 日本語 (2), ภาษาไทย (2), বাংলা (2), हिंदी (2), فارسی (2), العربيّة (2), עברית (2), русский (2), türkçe (2), tiếng (2), việt (2), português (2), brasil (2), polski (2), italiano (2), indonesia (2), français (2), américa (2), latina (2), deutsch (2), english (2), terms (2), platform (2), our (2), sample (2), follow (2), understand (2), need (2), too (2), many (2), last (2), 2026 (2), utc (2), except (2), licensed (2), under (2), site (2), feedback (2), verification (2), following (2), endpoints (2), sunset (2), 2018 (2), available (2), verify (2), configuring (2), either (2), server (2), must (2), eligible (2), shows (2), disallowed (2), target (2), fail (2), legacyinboundssochangenotallowedwithmultipartyapproval (2), errorcode (2), 1811 (2), multi (2), party (2), approval (2), sensitive (2), actions (2), yourbase64encodedpublickey (2), updating (2), then (2), sure (2), exactly (2), matches (2), generating (2), certificates (2), 127 (2), can (2), necessary (2), authenticate (2), multiple (2), determines (2), element (2), work (2), cidr (2), format (2), masks (2), previously (2), log (2), formatted (2), center (2), href (2), type (2), rel (2), link (2), syntax (2), bodies (2), provides (2), examples (2), basic (2), raw (2), control (2), such (2), servers (2), generate (2), private (2), well (2), logging (2), allows (2), hosted (2), publishing (2), custom (2), previews (2), updates (2), training (2), card (2), builder (2), marketplace (2), add (2), ons (2), extend (2), automate (2), share (2), vault (2), tasks (2), slides (2), sites (2), sheets (2), meet (2), keep (2), forms (2), classroom (2), calendar (2), printers (2), delete (2), photo (2), licenses (2), manager (2), directory (2), reseller (2), monitor (2), emails (2), audit (2), usage (2), oauth (2), aliases (2), structure (2), members (2), reference (2), cookies, privacy, firebase, android, connect, subscribe, channel, videos, try, guided, hands, coding, experience, explore, copy, them, build, own, workspacedevs, read, easy, easytounderstand, solved, problem, solvedmyproblem, otherup, missing, missingtheinformationineed, complicated, steps, toocomplicatedtoomanysteps, date, outofdate, issue, samplescodeissue, otherdown, tell, otherwise, noted, details, registered, trademark, oracle, its, affiliates, policies, apache, creative, commons, attribution, appearance, customlogo, countrycode, creationtime, adminsecondaryemail, customerpin, supportpin, maximumnumberofusers, currentnumberofusers, organizationname, defaultlanguage, deprecated, part, were, october, longer, announcement, oct, outside, through, working, after, agent, instructions, relayed, another, smtp_tls, secures, connection, tls, delivering, message, hostname, routes, outgoing, smtpout, possible, section, supports, required, though, most, deployments, useful, large, companies, entire, subdomains, giving, subdomain, associate, does, mask, classless, inter, specified, enables, configured, subsequently, entered, still, saved, where, sends, true, while, only, having, enter, once, stored, sections, demonstrate, help, edit, self, 887, t23, 2008, values, elements, represents, pair, containing, responses, full, each, operations, allow, specify, level, similar, functionality, dual, delivery, configuration, protocols, don, flow, pop, imap, clients, directly, username, communication, dsa, rsa, algorithms, 509, short, summary, query, involves, entering, communicate, stores, links, should, changing, passwords, programmatically, generated, was, modified, during, transmission, same, both, may, hosting, within, specifically, redirects, detailed, understanding, categories, types, testing, purposes, already, begin, assumes, ideas, behind, familiar, intended, who, write, applications, interactions, audience, implements, conform, editing, model, representational, restful, design, approach, guide, features, creating, panel, integrating, into, legacy, environment, form, save, categorize, preferences, stay, organized, collections, performance, tips, best, practices, browser, enrollment, token, core, print, printer, management, photos, errros, subscriptions, order, new, provision, download, mailbox, filter, queries, alerts, quickstart, alert, retention, lag, times, metrics, entities, tokens, logins, activity, reports, audits, security, people, migrate, migration, delegates, delegation, fields, roles, organizational, units, group, mobile, chromeos, consent, skip, main,

Text of the page (random words):
ts push notifications troubleshoot authentication authorization alert center api overview choose scopes install client libraries quickstart java set up alerts notifications send notifications filter queries troubleshoot errors email audit api overview choose scopes monitor emails download a mailbox domains licenses reseller api overview prerequisites choose scopes quickstarts javascript go google apps script java node js python install client libraries manage customers provision a customer order a new customer account retrieve update a customer s account information manage subscriptions create or transfer a subscription change a subscription status retrieve update a subscription push notifications troubleshoot troubleshoot authentication authorization troubleshoot reseller api errors troubleshoot directory api errors troubleshoot site verification api errros troubleshoot enterprise license manager api enterprise license manager api overview install client libraries choose scopes manage licenses send batch requests admin settings api choose scopes manage sso and email routing domain shared contacts api overview manage shared contacts create shared contacts get shared contacts update or delete shared contacts manage photos of shared contacts get a photo for a shared contact update or delete a photo for a shared contact troubleshoot chrome browsers printers chrome printer management api overview get started create manage printers create manage print servers chrome enterprise core api chrome browser enrollment token api best practices push notifications send batch requests performance tips google workspace apps admin console cloud search gmail google calendar google chat google classroom google docs google drive google forms google keep google meet google sheets google sites google slides google tasks google vault extend automate share add ons apps script chat apps drive apps marketplace tools admin console apps script dashboard google cloud console apis explorer card builder training support how to get started codelabs developer support updates release notes developer previews youtube newsletter x twitter blog home google workspace admin console guides send feedback admin settings api overview stay organized with collections save and categorize content based on your preferences the admin settings api allows administrators of google workspace domains to retrieve and change the settings of their domains in the form of the google data api feeds these domain settings include many of the features available in the google workspace admin console example uses of this api include creating a custom control panel or integrating google workspace domains into an existing legacy environment the admin settings api implements the google data api protocol the google data api conform to the atom publishing protocol atompub publishing and editing model the atompub http requests use the representational set transfer restful design approach to web services for more information see the google data apis developer s guide audience this document is intended for developers who want to write client applications that can modify and retrieve information about google workspace domains it provides examples of the basic admin settings api interactions using raw xml and http this document assumes that you understand the general ideas behind the the google data api protocol and that you are familiar with the google workspace admin console for more information about the admin console see use your admin console get started to begin using the admin settings api first set up your account create an account the admin settings api is enabled for google workspace accounts sign up for a google workspace account for testing purposes the admin settings service uses google accounts so if you already have an account on a google workspace domain you re all set note configure your domain settings using the admin settings api and use the email settings api to configure your users email settings about the admin settings api feed types the admin settings api lets you manage these categories of domain settings single sign on settings saml based single sign on sso allows users to use the same login and password for both google workspace hosted services as well as other services you may be hosting within your organization specifically when using sso a hosted web application such as google workspace redirects users to your organization s identity provider to authenticate users when they sign in for detailed information see understanding saml based sso for google workspace configuring sso involves entering the necessary information for the google workspace service to communicate with the identity provider that stores your users login information as well as setting up the links users should be sent to for logging in logging out and for changing their passwords the admin settings api lets you update and retrieve these settings programmatically google uses your generated public key to verify this sso request with your identity provider and that the private key saml response was not modified during the network transmission for a short api specific summary of using the sso settings get your public key certificate from your identity provider register the public key with google and set up your saml based sso query settings for error messages see troubleshooting sso generate your keys with your identity provider generate a set of public and private keys using either the dsa or rsa algorithms the public key is in an x 509 formatted certificate for more information about saml based single sign on signing keys see generating keys and certificates for google workspace single sign on service register with google use admin settings api s single sign on settings to register your public key certificate with google set up your sso settings use admin settings api s single sign on settings to configure the settings used to communication with the domain s identity provider s servers note for protocols that don t use a web based sign in flow such as some pop imap email clients users sign in directly with their google workspace username and password gateway settings this feed lets domain administrators control routing of email for their domains the email routing operations allow administrators to specify the domain level email routing settings this is similar to the email routing functionality of the admin console s gmail settings for more information see email routing and email routing feature s dual delivery configuration sample of an admin settings api xml request and response this document provides code examples of basic admin settings api requests and responses using raw xml and http this domain default language example shows the full xml and http syntax for a request and response entry s body which is common to each operation to change domain s outbound email gateway setting send an http put to the gateway feed url https apps apis google com a feeds domain 2 0 domainname email gateway the domain default language put request atompub entry xml is 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 except for the operation specific properties and values the atom property elements represents a single key value pair containing information about a property that you want to retrieve or update these are common to all admin settings api request bodies the domain default language response entry element returns the smarthost and smtpmode properties along with the xml syntax common to all admin settings api response bodies 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 17 t23 59 23 887 z 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 manage single sign on settings the google workspace single sign on feature sso lets users log on to multiple services while only having to enter a login and password once this password is stored by the domain s identity provider not by google workspace for more information see the help center s sso page the following sections demonstrate the xml format used for single sign on settings retrieve single sign on settings to retrieve single sign on settings send an http get to the sso general feed url and include an authorization header as described in authenticating to the admin settings service and for error messages see troubleshooting sso https apps apis google com a feeds domain 2 0 domainname sso general this operation has no parameters in the request body a successful response returns an http 200 ok status code along with an atompub feed with the domain s sso settings the get response xml returns the samlsignonuri samllogouturi changepassworduri enablesso ssowhitelist and usedomainspecificissuer properties 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 the properties include samlsignonuri the identity provider s url where google workspace sends the saml request for user authentication samllogouturi the address that users will be sent to when they log out of the web application changepassworduri the address that users will be sent to when they want to change their sso password for the web application enablesso enables saml based sso for this domain if you have previously configured sso settings and you have subsequently set enablesso to enablesso false the settings you have previously entered are still saved ssowhitelist a ssowhitelist is a network mask ip address in classless inter domain routing cidr format the ssowhitelist determines which users sign in using sso and which users sign in using the google workspace account authentication page if no masks are specified all users will sign in using sso for more information see how do network masks work usedomainspecificissuer a domain specific issuer can be used in the saml request to the identity provider though not necessary for most sso deployments this feature is useful in large companies using a single identity provider to authenticate an entire organization with multiple subdomains giving the specific domain issuer determines which subdomain to associate with the request for more information see how does the issuer element in the saml request work if your request fails for some reason a different status code is returned for more information about the google data api status codes see http status codes update single sign on settings to update a domain s sso settings first retrieve the sso settings using the retrieve single sign on settings operation modify it and then send a put request to the sso feed url be sure the id value is in your updated entry exactly matches the id of the existing entry include an authorization header as described in authenticating to the admin settings api service and for error messages see troubleshooting sso when updating single sign on settings send an http put to the sso general feed url https apps apis google com a feeds domain 2 0 domainname sso general the xml body of the put request is 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 a successful response returns an http 200 ok status code along with an atompub feed with the sso settings the put response xml is 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 if your request fails for some reason a different status code is returned for more information about the google data api status codes see http status codes changes to single sign on settings are disallowed when the target customer has enabled multi party approval for sensitive actions requests will fail with errorcode 1811 and reason legacyinboundssochangenotallowedwithmultipartyapproval retrieve the single sign on signing key to retrieve the single sign on signing key send an http get to the sso signing key feed url and include an authorization header as described in authenticating to the admin settings service and for error messages see troubleshooting sso https apps apis google com a feeds domain 2 0 domainname sso signingkey this operation has no parameters in the request body a successful response returns an http 200 ok status code along with an atompub feed with the signing key the get response xml returns the signingkey property 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 if your request fails for some reason a different status code is returned for more information about the google data api status codes see http status codes update the single sign on signing key to update a domain s sso signing key first retrieve the signing key using the retrieve single sign on signing key operation modify it and then send a put request to the sso signing key feed url be sure the id value is in your updated entry exactly matches the id of the existing entry for more information about saml based single sign on signing keys see generating keys and certificates for google workspace single sign on service when updating single sign on signing key send an http put to the sso signing key feed url https apps apis google com a feeds domain 2 0 domainname sso signingke...