एडमिन सेटिंग एपीआई की खास जानकारी

Admin Settings API की मदद से Google Workspace डोमेन के एडमिन, Google Data API फ़ीड के तौर पर, अपने डोमेन की सेटिंग वापस ला सकते हैं और उनमें बदलाव कर सकते हैं.

इन डोमेन सेटिंग में, Google Workspace Admin console में उपलब्ध कई सुविधाएं शामिल हैं. इस एपीआई के इस्तेमाल के उदाहरणों में, कस्टम कंट्रोल पैनल बनाना या Google Workspace डोमेन को किसी मौजूदा लेगसी एनवायरमेंट में इंटिग्रेट करना शामिल है.

Admin Settings API, Google Data API प्रोटोकॉल लागू करता है. Google Data API, ऐटम पब्लिशिंग प्रोटोकॉल (ऐटमPub) के पब्लिशिंग और एडिटिंग मॉडल के मुताबिक हो. AtomPub के एचटीटीपी अनुरोध, वेब सेवाओं के लिए रिप्रज़ेंटेशनल सेट ट्रांसफ़र (RESTful) डिज़ाइन प्रोसेस का इस्तेमाल करते हैं. ज़्यादा जानकारी के लिए, Google डेटा डेवलपर की गाइड देखें.

ऑडियंस

यह दस्तावेज़ उन डेवलपर के लिए है जो ऐसे क्लाइंट ऐप्लिकेशन लिखना चाहते हैं जो Google Workspace डोमेन की जानकारी में बदलाव कर सकें और उसे वापस पा सकें. इसमें, रॉ एक्सएमएल और एचटीटीपी का इस्तेमाल करके, Admin Settings API के बुनियादी इंटरैक्शन के उदाहरण दिए गए हैं.

इस दस्तावेज़ में हम यह मानकर चलते हैं कि आपको Google Data API प्रोटोकॉल के सामान्य आइडिया पता हैं और आपको Google Workspace के Admin console के बारे में भी जानकारी है. Admin console के बारे में ज़्यादा जानकारी के लिए, अपने Admin console का इस्तेमाल करना लेख देखें.

शुरू करें

खाता बनाना

Google Workspace खातों के लिए Admin Settings API चालू है. जांच करने के लिए, Google Workspace खाते में साइन अप करें. एडमिन सेटिंग सेवा के लिए, Google खातों का इस्तेमाल किया जाता है. इसलिए, अगर Google Workspace डोमेन पर आपके पास पहले से कोई खाता है, तो आपको कोई कार्रवाई करने की ज़रूरत नहीं है.

Admin Settings API फ़ीड के टाइप के बारे में जानकारी

Admin Settings API से, आपको डोमेन सेटिंग की इन कैटगरी को मैनेज करने की सुविधा मिलती है:

सिंगल साइन-ऑन सेटिंग

एसएएमएल पर आधारित सिंगल साइन-ऑन (एसएसओ) सुविधा की मदद से उपयोगकर्ता, Google Workspace की होस्ट की गई सेवाओं के साथ-साथ अपने संगठन में होस्ट की जाने वाली अन्य सेवाओं के लिए, एक ही लॉगिन और पासवर्ड का इस्तेमाल कर सकते हैं. खास तौर पर, Google Workspace जैसे होस्ट किए गए वेब ऐप्लिकेशन एसएसओ का इस्तेमाल करते समय, उपयोगकर्ताओं को लॉग इन करने पर उनकी पुष्टि करने के लिए, उन्हें आपके संगठन के आइडेंटिटी प्रोवाइडर पर रीडायरेक्ट किया जाता है. ज़्यादा जानकारी के लिए, Google Workspace के लिए एसएएमएल-आधारित एसएसओ (SSO) के बारे में जानकारी लेख पढ़ें.

एसएसओ कॉन्फ़िगर करने के लिए, Google Workspace सेवा के लिए ज़रूरी जानकारी डालना ज़रूरी है. इसकी मदद से, उस आइडेंटिटी प्रोवाइडर से संपर्क किया जा सकता है जो आपके उपयोगकर्ताओं के खातों को सेव करती है लॉगिन जानकारी, और वे लिंक सेट अप करना जिन पर लोगों को लॉग इन करने, लॉग आउट करने, और अपने पासवर्ड बदलने के लिए भेजा जाना चाहिए. Admin Settings API की मदद से, प्रोग्राम के हिसाब से इन सेटिंग को अपडेट और वापस पाया जा सकता है. Google, आपके आइडेंटिटी प्रोवाइडर से इस एसएसओ (SSO) अनुरोध की पुष्टि करने के लिए, जनरेट की गई सार्वजनिक कुंजी का इस्तेमाल करता है. इससे यह भी पता चलता है कि नेटवर्क ट्रांसमिशन के दौरान, निजी पासकोड के एसएएमएल रिस्पॉन्स में बदलाव नहीं हुआ है.

एपीआई की सेटिंग के इस्तेमाल से जुड़ी खास जानकारी के लिए, अपने आइडेंटिटी प्रोवाइडर से सार्वजनिक पासकोड का सर्टिफ़िकेट लें, Google के साथ सार्वजनिक पासकोड रजिस्टर करें, और एसएएमएल पर आधारित एसएसओ (SSO) क्वेरी की सेटिंग को सेट अप करें. गड़बड़ी के मैसेज के लिए, एसएसओ (SSO) से जुड़ी समस्याओं का हल देखें:

• अपनी कुंजियां जनरेट करें -- अपने आइडेंटिटी प्रोवाइडर की मदद से, डीएसए या आरएसए एल्गोरिदम का इस्तेमाल करके सार्वजनिक और निजी पासकोड का सेट जनरेट करें. सार्वजनिक कुंजी, X.509 फ़ॉर्मैट वाले सर्टिफ़िकेट में होती है. एसएएमएल पर आधारित सिंगल साइन-ऑन साइनिंग की के बारे में ज़्यादा जानकारी के लिए, Google Workspace की सिंगल साइन-ऑन सेवा के लिए पासकोड और सर्टिफ़िकेट जनरेट करना लेख पढ़ें.
• Google के साथ रजिस्टर करें -- अपने सार्वजनिक पासकोड सर्टिफ़िकेट को Google के साथ रजिस्टर करने के लिए, Admin Settings API की सिंगल साइन-ऑन सेटिंग का इस्तेमाल करें.
• अपनी एसएसओ (SSO) सेटिंग सेट करें -- डोमेन के आइडेंटिटी प्रोवाइडर के सर्वर से संपर्क करने के लिए इस्तेमाल की जाने वाली सेटिंग कॉन्फ़िगर करने के लिए, एडमिन सेटिंग एपीआई की सिंगल साइन-ऑन सेटिंग का इस्तेमाल करें.

गेटवे और रूटिंग की सेटिंग

इस फ़ीड की मदद से डोमेन एडमिन अपने डोमेन के लिए, ईमेल की रूटिंग को कंट्रोल कर सकते हैं.

ईमेल रूटिंग ऑपरेशन, व्यवस्थापक को डोमेन-स्तरीय ईमेल रूटिंग सेटिंग तय करने की अनुमति देते हैं. यह Admin console की Gmail सेटिंग की ईमेल रूटिंग सुविधा की तरह है. ज़्यादा जानकारी के लिए, ईमेल रूटिंग और ईमेल रूटिंग सुविधा का दोहरा वितरण कॉन्फ़िगरेशन देखें.

Admin Settings API एक्सएमएल अनुरोध और रिस्पॉन्स का सैंपल

इस दस्तावेज़ में, रॉ एक्सएमएल और एचटीटीपी का इस्तेमाल करके, एडमिन सेटिंग एपीआई के बेसिक अनुरोधों और रिस्पॉन्स के कोड के उदाहरण दिए गए हैं. डोमेन की डिफ़ॉल्ट भाषा का यह उदाहरण, अनुरोध और रिस्पॉन्स एंट्री के मुख्य हिस्से का पूरा एक्सएमएल और एचटीटीपी सिंटैक्स दिखाता है, जो हर कार्रवाई के लिए एक जैसा होता है:

डोमेन की आउटबाउंड ईमेल गेटवे सेटिंग बदलने के लिए, गेटवे फ़ीड के यूआरएल पर एक एचटीटीपी PUT भेजें:

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

डोमेन की डिफ़ॉल्ट भाषा PUT अनुरोध AtomPub entry एक्सएमएल यह है:

<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>

खास कार्रवाई और वैल्यू को छोड़कर, atom:property एलिमेंट एक ही की-वैल्यू पेयर को दिखाता है. इसमें उस प्रॉपर्टी की जानकारी होती है जिसे आपको वापस पाना या अपडेट करना है. ये सभी Admin Settings API अनुरोध के निकायों में आम हैं.

डोमेन के डिफ़ॉल्ट भाषा रिस्पॉन्स entry एलिमेंट में, smartHost और smtpMode प्रॉपर्टी के साथ-साथ एक्सएमएल सिंटैक्स भी मिलता है, जो एडमिन सेटिंग एपीआई के रिस्पॉन्स बॉडी के लिए एक जैसा होता है:

<?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>

एकल साइन-ऑन सेटिंग प्रबंधित करना

Google Workspace की सिंगल साइन-ऑन सुविधा (एसएसओ) की मदद से, उपयोगकर्ता कई सेवाओं में लॉग इन कर सकते हैं. इसके लिए, उन्हें सिर्फ़ एक बार लॉगिन और पासवर्ड डालना पड़ता है. यह पासवर्ड, डोमेन के आइडेंटिटी प्रोवाइडर ने सेव किया है, न कि Google Workspace. ज़्यादा जानकारी के लिए, सहायता केंद्र का एसएसओ (SSO) पेज देखें. यहां दिए गए सेक्शन में, सिंगल साइन-ऑन सेटिंग के लिए इस्तेमाल किए जाने वाले एक्सएमएल फ़ॉर्मैट के बारे में बताया गया है.

एकल साइन-ऑन सेटिंग पुनर्प्राप्त करना

सिंगल साइन-ऑन सेटिंग वापस पाने के लिए, एसएसओ (SSO) के सामान्य फ़ीड के यूआरएल पर एचटीटीपी GET भेजें. साथ ही, एडमिन की सेटिंग सेवा की पुष्टि करने की प्रक्रिया में बताए गए तरीके के मुताबिक एक Authorization हेडर शामिल करें. और, गड़बड़ी के मैसेज के लिए, समस्या हल करने वाली एसएसओ (SSO) देखें:

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

इस कार्रवाई के अनुरोध के मुख्य भाग में कोई पैरामीटर नहीं है.

सही जवाब मिलने पर, डोमेन की एसएसओ (SSO) सेटिंग के साथ AtomPub फ़ीड के साथ एचटीटीपी 200 OK स्टेटस कोड दिखता है.

जीईटी रिस्पॉन्स एक्सएमएल, samlSignonUri, samlLogoutUri, changePasswordUri, enableSSO, ssoWhitelist, और 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>

प्रॉपर्टी में ये शामिल हैं:

samlSignonUri

पहचान देने वाली सेवा का वह यूआरएल जहां Google Workspace, उपयोगकर्ता की पुष्टि करने के लिए एसएएमएल अनुरोध भेजता है.

samlLogoutUri

वह पता जिस पर उपयोगकर्ताओं को वेब ऐप्लिकेशन से लॉग आउट करने पर भेजा जाएगा.

changePasswordUri

वह पता जिस पर उपयोगकर्ताओं को तब भेजा जाएगा, जब वे वेब ऐप्लिकेशन के लिए अपना एसएसओ (SSO) पासवर्ड बदलना चाहेंगे.

enableSSO

इस डोमेन के लिए, एसएएमएल-आधारित एसएसओ (SSO) को चालू करती है. अगर आपने पहले एसएसओ (SSO) सेटिंग कॉन्फ़िगर की हैं और बाद में enableSSO को enableSSO=false पर सेट कर दिया है, तो पहले डाली गई सेटिंग में कोई बदलाव नहीं होगा.

ssoWhitelist

ssoव्हाइट एक नेटवर्क मास्क आईपी पता होता है. यह क्लासलेस इंटर-डोमेन रूटिंग (सीआईडीआर) फ़ॉर्मैट में होता है. sso श्वेतसूची से यह तय होता है कि किन उपयोगकर्ताओं ने एसएसओ (SSO) का इस्तेमाल करके लॉग इन किया है और कौनसे उपयोगकर्ता Google Workspace खाते की पुष्टि करने वाले पेज पर जाकर लॉग इन कर सकते हैं. अगर कोई मास्क तय नहीं किया गया है, तो सभी उपयोगकर्ता एसएसओ (SSO) का इस्तेमाल करके लॉग इन करेंगे. ज़्यादा जानकारी के लिए, नेटवर्क मास्क कैसे काम करते हैं देखें.

useDomainSpecificIssuer

पहचान देने वाली सेवा को किए जाने वाले एसएएमएल अनुरोध में, डोमेन के हिसाब से जारी करने वाले का इस्तेमाल किया जा सकता है. हालांकि, यह सुविधा ज़्यादातर एसएसओ (SSO) डिप्लॉयमेंट के लिए ज़रूरी नहीं है, लेकिन यह सुविधा उन बड़ी कंपनियों में काम की है जो एक ही आइडेंटिटी प्रोवाइडर का इस्तेमाल करके, एक से ज़्यादा सबडोमेन वाले पूरे संगठन की पहचान की पुष्टि करती हैं. किसी डोमेन को जारी करने वाले को देने से यह तय होता है कि अनुरोध के साथ कौनसा सबडोमेन जोड़ा जाएगा. ज़्यादा जानकारी के लिए, देखें कि SAML अनुरोध में जारी करने वाला एलिमेंट कैसे काम करता है?

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक अलग स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

सिंगल साइन-ऑन सेटिंग अपडेट करना

किसी डोमेन की एसएसओ (SSO) सेटिंग अपडेट करने के लिए, सबसे पहले एकल साइन-ऑन सेटिंग वापस पाना कार्रवाई का इस्तेमाल करके एसएसओ (SSO) सेटिंग फिर से पाएं, उनमें बदलाव करें, और फिर एसएसओ (SSO) फ़ीड के यूआरएल पर एक PUT अनुरोध भेजें. पक्का करें कि आपकी अपडेट की गई एंट्री में <id> वैल्यू, मौजूदा एंट्री के <id> से पूरी तरह मेल खाती हो. Admin Settings API सेवा की पुष्टि करने में बताए गए तरीके के मुताबिक Authorization हेडर शामिल करें. और गड़बड़ी के मैसेज के लिए, एसएसओ (SSO) से जुड़ी समस्याओं का हल देखें.

सिंगल साइन-ऑन सेटिंग अपडेट करते समय, एसएसओ (SSO) के सामान्य फ़ीड यूआरएल पर एक एचटीटीपी PUT भेजें:

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

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>

सही जवाब मिलने पर, एचटीटीपी 200 OK स्टेटस कोड के साथ-साथ एसएसओ (SSO) सेटिंग वाला AtomPub फ़ीड भी दिखाया जाता है.

यह 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>

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक अलग स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

सिंगल साइन-ऑन सेटिंग में बदलाव तब नहीं किए जा सकते, जब टारगेट ग्राहक ने संवेदनशील कार्रवाइयों के लिए, कई पक्षों से अनुमति की सुविधा चालू की हो. errorCode="1811" और reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" के साथ अनुरोध पूरे नहीं हो पाएंगे.

सिंगल साइन-ऑन साइनिंग पासकोड वापस पाना

सिंगल साइन-ऑन साइनिंग पासकोड वापस पाने के लिए, एसएसओ साइनिंग पासकोड फ़ीड के यूआरएल पर एचटीटीपी GET भेजें. साथ ही, एडमिन की सेटिंग सेवा में पुष्टि करने की सुविधा में बताए गए तरीके के मुताबिक एक Authorization हेडर शामिल करें. और, गड़बड़ी के मैसेज के लिए, समस्या हल करने वाली एसएसओ (SSO) देखें:

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

इस कार्रवाई के अनुरोध के मुख्य भाग में कोई पैरामीटर नहीं है.

सही रिस्पॉन्स मिलने पर, एचटीटीपी 200 OK स्टेटस कोड के साथ-साथ साइनिंग पासकोड के साथ AtomPub फ़ीड भी दिखाया जाता है.

GET रिस्पॉन्स एक्सएमएल, 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>

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक अलग स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

सिंगल साइन-ऑन साइनिंग पासकोड को अपडेट करना

किसी डोमेन की एसएसओ (SSO) साइनिंग पासकोड अपडेट करने के लिए, सबसे पहले सिंगल साइन-ऑन साइनिंग पासकोड वापस पाना कार्रवाई का इस्तेमाल करके, साइनिंग पासकोड को वापस लाएं. इसके बाद, उसमें बदलाव करें और एसएसओ साइनिंग पासकोड फ़ीड के यूआरएल पर एक PUT अनुरोध भेजें. पक्का करें कि आपकी अपडेट की गई एंट्री में <id> वैल्यू, मौजूदा एंट्री के <id> से पूरी तरह मेल खाती हो. एसएएमएल पर आधारित सिंगल साइन-ऑन साइनिंग की के बारे में ज़्यादा जानकारी के लिए, Google Workspace की सिंगल साइन-ऑन सेवा के लिए पासकोड और सर्टिफ़िकेट जनरेट करना लेख पढ़ें.

सिंगल साइन-ऑन साइनिंग पासकोड को अपडेट करते समय, एसएसओ (SSO) साइनिंग पासकोड फ़ीड के यूआरएल पर एक एचटीटीपी PUT भेजें:

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

यह 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>

सिंगल साइन-ऑन सेटिंग में बदलाव तब नहीं किए जा सकते, जब टारगेट ग्राहक ने संवेदनशील कार्रवाइयों के लिए, कई पक्षों से अनुमति की सुविधा चालू की हो. errorCode="1811" और reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" के साथ अनुरोध पूरे नहीं हो पाएंगे.

ईमेल गेटवे और रूटिंग मैनेज करना

आउटबाउंड ईमेल गेटवे सेक्शन में दिखाया जाता है कि Admin Settings API, आपके डोमेन के उपयोगकर्ताओं के मेल की आउटबाउंड रूटिंग के साथ कैसे काम करता है. ईमेल रूटिंग अनुभाग, संदेशों को किसी अन्य मेल सर्वर पर रूट करने का तरीका दिखाता है.

आउटबाउंड ईमेल गेटवे सेटिंग पुनर्प्राप्त की जा रही है

आउटबाउंड ईमेल गेटवे सेटिंग फिर से पाने के लिए, गेटवे फ़ीड यूआरएल पर एक एचटीटीपी GET भेजें. साथ ही, एक Authorization हेडर शामिल करें, जैसा कि एडमिन सेटिंग सेवा के लिए पुष्टि करना में बताया गया है:

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

इस कार्रवाई के अनुरोध के मुख्य भाग में कोई पैरामीटर नहीं है.

सही रिस्पॉन्स मिलने पर, एचटीटीपी 200 OK स्टेटस कोड दिखता है. साथ ही, ईमेल गेटवे के स्टेटस की जानकारी के साथ AtomPub फ़ीड भी दिखता है.

GET रिस्पॉन्स, smartHost और smtpMode प्रॉपर्टी दिखाता है. इन प्रॉपर्टी के बारे में ज़्यादा जानकारी के लिए, आउटबाउंड ईमेल गेटवे सेटिंग अपडेट करना देखें.

संभावित जवाब का एक उदाहरण यह है:

<?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>

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक अलग स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

आउटबाउंड ईमेल गेटवे सेटिंग अपडेट की जा रही हैं

किसी डोमेन की आउटबाउंड ईमेल गेटवे सेटिंग अपडेट करने के लिए, गेटवे फ़ीड के यूआरएल पर एक एचटीटीपी PUT अनुरोध भेजें:

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

यह 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>

अनुरोध की प्रॉपर्टी:

smartHost

आपके एसएमटीपी सर्वर का आईपी पता या होस्टनेम. Google Workspace, आउटगोइंग मेल को इस सर्वर पर रूट करता है.

smtpMode

डिफ़ॉल्ट वैल्यू एसएमटीपी है. दूसरा मान, SMTP_TLS, मैसेज डिलीवर करते समय TLS के साथ कनेक्शन सुरक्षित करता है.

सही रिस्पॉन्स मिलने पर, एचटीटीपी 200 OK स्टेटस कोड दिखता है. साथ ही, ईमेल गेटवे सेटिंग के स्टेटस के साथ, AtomPub फ़ीड भी दिखता है.

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक अलग स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

ईमेल रूटिंग सेटिंग प्रबंधित करना

सबसे पहले, एक्सएमएल अनुरोध करें:

<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>

अनुरोध की प्रॉपर्टी:

routeDestination

यह डेस्टिनेशन, उस एसएमटीपी-इन मेल सर्वर का होस्टनेम या आईपी पता है जहां ईमेल को रूट किया जा रहा है. Google के लिए, होस्टनेम या आईपी पते का समाधान होना ज़रूरी है. मेल होस्ट के नामों को हल करने के बारे में ज़्यादा जानकारी के लिए, ईमेल रूटिंग के साथ Google Workspace का पायलट प्रोग्राम देखें.

routeRewriteTo

अगर सही है, तो मैसेज के एसएमटीपी एन्वेलप का to: फ़ील्ड डेस्टिनेशन होस्टनेम (user@destination's होस्टनेम) में बदल जाता है और मैसेज डेस्टिनेशन मेल सर्वर पर इस उपयोगकर्ता पते पर डिलीवर हो जाता है. अगर false है, तो ईमेल को गंतव्य मेल सर्वर के मूल मैसेज के to: ईमेल पते (user@original होस्टनेम) पर डिलीवर किया जाता है. यह Admin console के 'SMTP एनवलप बदलें' के जैसा है सेटिंग. ज़्यादा जानकारी के लिए, ईमेल रूटिंग के लिए डोमेन सेटिंग देखें.

routeEnabled

अगर true, तो ईमेल रूटिंग फ़ंक्शन चालू हो जाता है. अगर false है, तो यह सुविधा बंद हो जाती है.

bounceNotifications

अगर true, डिलीवरी न हो पाने पर, Google Workspace को ईमेल भेजने वाले व्यक्ति को बाउंस होने की सूचनाएं भेजने की सुविधा देता है.

accountHandling

यह सेटिंग तय करती है कि डोमेन में मौजूद अलग-अलग तरह के उपयोगकर्ता, ईमेल रूटिंग का कैसे प्रभावित होते हैं:

• allAccounts -- सभी ईमेल इस गंतव्य पर डिलीवर करें.
• provisionedAccounts -- अगर उपयोगकर्ता Google Workspace का इस्तेमाल करता है, तो ईमेल इस डेस्टिनेशन पर डिलीवर करें.
• unknownAccounts -- अगर उपयोगकर्ता Google Workspace में मौजूद नहीं है, तो इस डेस्टिनेशन पर मेल डिलीवर करें. यह Admin console के 'डिलीवरी के लिए ईमेल पता' की तरह है सेटिंग. ज़रूरी शर्तों और मेल रूटिंग का इस्तेमाल करने के तरीके के बारे में ज़्यादा जानकारी के लिए, ईमेल रूटिंग के लिए डोमेन सेटिंग देखें. ~ इस अनुरोध को पब्लिश करने के लिए, ईमेल रूटिंग फ़ीड के यूआरएल पर एचटीटीपी POST भेजें. साथ ही, एडमिन सेटिंग सेवा के लिए पुष्टि करने की सुविधा में बताए गए तरीके के मुताबिक एक Authorization हेडर शामिल करें:

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

सही जवाब मिलने पर, संग्रहित की जानकारी के साथ AtomPub फ़ीड के साथ-साथ एचटीटीपी 200 OK स्टेटस कोड दिखता है.

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो एक अलग स्टेटस कोड दिखता है. Google Data API के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

एंडपॉइंट 31 अक्टूबर, 2018 को बंद हो जाएंगे

इस घोषणा के हिस्से के तौर पर, हमने इन एंडपॉइंट को बंद कर दिया है. इन्हें 31 अक्टूबर, 2018 को बंद कर दिया गया था और अब उपलब्ध नहीं हैं.

• 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