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

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

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

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

ऑडियंस

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

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

शुरू करें

खाता बनाना

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

एडमिन सेटिंग एपीआई के फ़ीड टाइप के बारे में जानकारी

एडमिन सेटिंग एपीआई की मदद से, डोमेन सेटिंग की इन कैटगरी को मैनेज किया जा सकता है:

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

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

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

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

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

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

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

ईमेल रूटिंग ऑपरेशन की मदद से, एडमिन डोमेन-लेवल पर ईमेल रूटिंग की सेटिंग तय कर सकते हैं. यह सुविधा, 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 एलिमेंट, ऑपरेशन से जुड़ी प्रॉपर्टी और वैल्यू को छोड़कर, एक ही की-वैल्यू पेयर को दिखाते हैं. इसमें उस प्रॉपर्टी की जानकारी होती है जिसे आपको वापस लाना या अपडेट करना है. ये सभी एडमिन सेटिंग एपीआई अनुरोध बॉडी के लिए सामान्य हैं.

डोमेन की डिफ़ॉल्ट भाषा का रिस्पॉन्स 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. ज़्यादा जानकारी के लिए, सहायता केंद्र का एसएसओ पेज देखें. नीचे दिए गए सेक्शन में, सिंगल साइन-ऑन सेटिंग के लिए इस्तेमाल किए जाने वाले एक्सएमएल फ़ॉर्मैट के बारे में बताया गया है.

सिंगल साइन-ऑन की सेटिंग हासिल करना

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

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

इस ऑपरेशन के अनुरोध बॉडी में कोई पैरामीटर नहीं है.

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

GET रिस्पॉन्स एक्सएमएल, 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) की सेटिंग कॉन्फ़िगर की है और बाद में enableSSO को enableSSO=false पर सेट किया है, तो पहले से डाली गई सेटिंग अब भी सेव रहेंगी.

ssoWhitelist

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

useDomainSpecificIssuer

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

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

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

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

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

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 स्टेटस कोड के साथ-साथ, एसएसओ सेटिंग वाला 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 हेडर शामिल करें. गड़बड़ी के मैसेज के लिए, एसएसओ से जुड़ी समस्या हल करना लेख पढ़ें:

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 के स्टेटस कोड के बारे में ज़्यादा जानने के लिए, एचटीटीपी स्टेटस कोड देखें.

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

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

सिंगल साइन-ऑन साइनिंग पासकोड को अपडेट करते समय, एसएसओ साइनिंग पासकोड फ़ीड के यूआरएल पर एचटीटीपी 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 है. 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

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

routeRewriteTo

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

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

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

अगर किसी वजह से आपका अनुरोध पूरा नहीं हो पाता है, तो आपको एक अलग स्टेटस कोड दिखता है. 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