Method: users.settings.cse.keypairs.get

यह फ़ंक्शन, क्लाइंट-साइड एन्क्रिप्शन की मौजूदा कुंजियों के जोड़े को वापस पाता है.

अपने संगठन के उपयोगकर्ताओं के लिए पहचान और कुंजी जोड़े मैनेज करने वाले एडमिन को अनुरोधों के लिए अनुमति चाहिए. इसके लिए, उन्हें सेवा खाते का इस्तेमाल करना होगा. इस खाते के पास पूरे डोमेन के लिए डेलिगेशन की अनुमति होनी चाहिए, ताकि वह https://www.googleapis.com/auth/gmail.settings.basic स्कोप वाले उपयोगकर्ताओं के तौर पर काम कर सके.

अपनी पहचान और की-पेयर मैनेज करने वाले उपयोगकर्ताओं के लिए, अनुरोधों में हार्डवेयर की एन्क्रिप्शन चालू और कॉन्फ़िगर होना चाहिए.

एचटीटीपी अनुरोध

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
userId

string

अनुरोध करने वाले व्यक्ति का मुख्य ईमेल पता. प्रमाणीकरण किए गए उपयोगकर्ता के लिए, me वैल्यू का इस्तेमाल किया जा सकता है.
keyPairId

string

उस कुंजी के जोड़े का आइडेंटिफ़ायर जिसे वापस पाना है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में CseKeyPair का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

ज़्यादा जानकारी के लिए, OAuth 2.0 Overview देखें.