Mail Admin Quarantine API को कॉल करने से पहले, इस पेज पर दिया गया तरीका अपनाकर एपीआई को चालू करें. साथ ही, हर अनुरोध के लिए ज़रूरी आइडेंटिफ़ायर ढूंढें और अपने Google Workspace खाते में एडमिन के ज़रूरी अधिकार दें.
ज़रूरी शर्तें
- ऐसा Google Workspace खाता जिसमें एडमिन क्वॉरंटीन की सुविधा हो. ज़्यादा जानने के लिए, ईमेल क्वॉरंटीन सेट अप और मैनेज करना लेख पढ़ें.
- एक Google Cloud प्रोजेक्ट. प्रोजेक्ट बनाने के लिए, प्रोजेक्ट बनाना लेख पढ़ें.
- Google Workspace Developer Preview Program की सदस्यता. Admin Quarantine API को कॉल करने से पहले, आपके Cloud प्रोजेक्ट को इस प्रोग्राम में रजिस्टर करना ज़रूरी है.
- सुपर एडमिन के तौर पर Google Admin console का ऐक्सेस, ताकि एडमिन के अधिकार दिए जा सकें और पूरे डोमेन के लिए ऐक्सेस देने की अनुमति दी जा सके.
एपीआई को चालू करना
उस क्लाउड प्रोजेक्ट में mailadminquarantine.googleapis.com को चालू करें जिसमें आपका इंटिग्रेशन होस्ट किया गया है.
कंसोल
Google Cloud Console में, Mail Admin Quarantine API को चालू करें.
gcloud
PROJECT_ID की जगह अपना Cloud प्रोजेक्ट आईडी डालकर, यह कमांड चलाएं:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
अपनी ग्राहक ID जानें
Admin Quarantine API को किए जाने वाले हर अनुरोध में, आपके Google Workspace खाते की पहचान customers/CUSTOMER_ID रिसॉर्स नेम से की जाती है.
अपना ग्राहक आईडी ढूंढने के लिए:
- एडमिन के तौर पर, Admin console में साइन इन करें.
- खाता > खाते की सेटिंग > प्रोफ़ाइल पर जाएं.
- ग्राहक आईडी कॉपी करें.
अगर ग्राहक आईडी C से शुरू होता है, तो C को हटाएं और संसाधन के नाम में बाकी बची अक्षरों और अंकों वाली वैल्यू का इस्तेमाल करें. उदाहरण के लिए, customers/01abc23de.
ग्राहक आईडी के तौर पर अपने डोमेन नेम का इस्तेमाल न करें.
ज़्यादा जानकारी के लिए, अपना ग्राहक आईडी ढूंढना लेख पढ़ें.
एडमिन के ज़रूरी अधिकार देना
Admin Quarantine API, एडमिन के अधिकारों की जांच उसी तरह करता है जिस तरह Admin console में एडमिन क्वॉरंटीन करता है. हर अनुरोध, Google Workspace एडमिन की ओर से किया जाता है. उस एडमिन के पास Gmail से जुड़ा इनमें से कोई एक अधिकार होना चाहिए:
| प्रिवलेज | इससे क्या किया जा सकता है |
|---|---|
| एडमिन क्वॉरंटीन को ऐक्सेस करना | सभी क्वॉरंटीन में मौजूद मैसेज ऐक्सेस और मैनेज करना. इसमें डिफ़ॉल्ट क्वॉरंटीन भी शामिल है. |
| सीमित ऐक्सेस वाले क्वॉरंटीन किए गए ईमेल ऐक्सेस करना | सिर्फ़ उन क्वॉरंटीन में मौजूद मैसेज को ऐक्सेस और मैनेज करना जो एडमिन के ग्रुप से जुड़े हैं. |
सुपर एडमिन को ये अनुमतियां अपने-आप मिल जाती हैं. अन्य एडमिन को ऐसी भूमिका असाइन करें जिसमें यह अधिकार शामिल हो:
- सुपर एडमिन के तौर पर, Admin console में साइन इन करें.
- खाता > एडमिन की भूमिकाएं पर जाएं.
- कोई मौजूदा भूमिका चुनें या नई भूमिका बनाएं पर क्लिक करें.
- अनुमतियां टैब में, सेवाएं > Gmail पर जाएं. इसके बाद, एडमिन क्वॉरंटीन को ऐक्सेस करें या प्रतिबंधित क्वॉरंटीन को ऐक्सेस करें को चुनें.
- उस एडमिन खाते को भूमिका असाइन करें जिसे आपका इंटिग्रेशन, एपीआई को कॉल करते समय इस्तेमाल करता है.
एडमिन के तौर पर सौंपी गई भूमिकाओं के बारे में जानकारी पाने के लिए, Gmail में एडमिन के अधिकार सौंपना और एडमिन के अधिकारों की परिभाषाएं देखें.
अगर किसी दूसरे एडमिन के तौर पर काम करने वाले एडमिन के पास ज़रूरी अधिकार नहीं है, तो एपीआई 403 PERMISSION_DENIED गड़बड़ी दिखाता है.