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

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 API की डेवलपर गाइड.

ऑडियंस

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

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

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

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

गेटवे की सेटिंग

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

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

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

इस दस्तावेज़ में, रॉ एक्सएमएल और एचटीटीपी का इस्तेमाल करके, 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 प्रॉपर्टी के साथ-साथ, सभी Admin Settings API के रिस्पॉन्स के मुख्य हिस्सों के लिए एक जैसा एक्सएमएल सिंटैक्स दिखाता है:

<?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 भेजें. साथ ही, Admin Settings सेवा में पुष्टि करना लेख में बताए गए तरीके से, 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 से यह तय होता है कि कौनसे उपयोगकर्ता एसएसओ का इस्तेमाल करके साइन इन करेंगे और कौनसे उपयोगकर्ता Google Workspace खाते की पुष्टि करने वाले पेज का इस्तेमाल करके साइन इन करेंगे. अगर कोई मास्क नहीं चुना गया है, तो सभी उपयोगकर्ता एसएसओ का इस्तेमाल करके साइन इन करेंगे. ज़्यादा जानकारी के लिए, नेटवर्क मास्क कैसे काम करते हैं लेख पढ़ें.
useDomainSpecificIssuer
एसएएमएल अनुरोध में, आइडेंटिटी प्रोवाइडर के लिए डोमेन के हिसाब से जारी करने वाले का इस्तेमाल किया जा सकता है. एसएसओ के ज़्यादातर डिप्लॉयमेंट के लिए, यह सुविधा ज़रूरी नहीं है. हालांकि, बड़ी कंपनियों के लिए यह सुविधा काम की है. ये कंपनियां, एक ही आइडेंटिटी प्रोवाइडर का इस्तेमाल करके, कई सबडोमेन वाले पूरे संगठन की पुष्टि करती हैं. डोमेन के हिसाब से जारी करने वाले की जानकारी देने से यह तय होता है कि अनुरोध को किस सबडोमेन से जोड़ा जाए. ज़्यादा जानकारी के लिए, देखें एसएएमएल अनुरोध में, जारी करने वाले एलिमेंट कैसे काम करता है?

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

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

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

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

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 हेडर शामिल करें, जैसा कि Admin Settings सेवा में पुष्टि करना लेख में बताया गया है:

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
डिफ़ॉल्ट वैल्यू, एसएमटीपी है. एक और वैल्यू, एसएमटीपी_टीएलएस, मैसेज डिलीवर करते समय टीएलएस के साथ कनेक्शन को सुरक्षित करती है.

अनुरोध पूरा होने पर, एचटीटीपी 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