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

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 एचटीटीपी अनुरोध, वेब सेवाओं के लिए Representational Set Transfer (RESTful) डिज़ाइन अप्रोच का इस्तेमाल करते हैं. ज़्यादा जानकारी के लिए, Google Data APIs Developer's Guide देखें.

ऑडियंस

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

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

शुरू करें

Admin Settings API का इस्तेमाल शुरू करने के लिए, पहले अपना खाता सेट अप करें.

खाता बनाएं

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

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

Admin Settings API की मदद से, डोमेन की इन सेटिंग को मैनेज किया जा सकता है:

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

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

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

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

• अपनी कुंजियां जनरेट करें -- अपने आइडेंटिटी प्रोवाइडर की मदद से, DSA या RSA एल्गोरिदम का इस्तेमाल करके सार्वजनिक और निजी कुंजियों का सेट जनरेट करें. सार्वजनिक पासकोड, 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 एलिमेंट, एक की-वैल्यू पेयर को दिखाता है. इसमें उस प्रॉपर्टी के बारे में जानकारी होती है जिसे आपको वापस पाना है या अपडेट करना है. ये सभी Admin Settings API अनुरोधों के मुख्य हिस्से में मौजूद होते हैं.

डोमेन की डिफ़ॉल्ट भाषा के रिस्पॉन्स entry एलिमेंट से, smartHost और smtpMode प्रॉपर्टी मिलती हैं. साथ ही, इसमें एडमिन सेटिंग वाले एपीआई के रिस्पॉन्स के सभी मुख्य हिस्सों के लिए सामान्य XML सिंटैक्स होता है:

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

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

enableSSO

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

ssoWhitelist

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

useDomainSpecificIssuer

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

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

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

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

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

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

किसी डोमेन के एसएसओ (SSO) साइनिंग पासकोड को अपडेट करने के लिए, सबसे पहले सिंगल साइन-ऑन साइनिंग पासकोड वापस पाएं ऑपरेशन का इस्तेमाल करके, साइनिंग पासकोड वापस पाएं. इसके बाद, उसमें बदलाव करें. इसके बाद, एसएसओ (SSO) साइनिंग पासकोड फ़ीड के यूआरएल पर 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 भेजें. साथ ही, Admin Settings सेवा से पुष्टि करना में बताए गए तरीके से, 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

आपके SMTP सर्वर का आईपी पता या होस्टनेम. Google Workspace, भेजे जाने वाले ईमेल को इस सर्वर पर रूट करता है.

smtpMode

डिफ़ॉल्ट वैल्यू SMTP है. SMTP_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's hostname) में बदल दिया जाता है. साथ ही, मैसेज को डेस्टिनेशन के मेल सर्वर पर मौजूद इस उपयोगकर्ता के पते पर डिलीवर कर दिया जाता है. अगर 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