Method: users.settings.cse.keypairs.list

इस तरीके से, पुष्टि किए गए उपयोगकर्ता के लिए क्लाइंट-साइड एन्क्रिप्शन की कुंजियों के जोड़े दिखाए जाते हैं.

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
userId

string

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

क्वेरी पैरामीटर

पैरामीटर
pageToken

string

पेज नंबर वाला टोकन, जिससे यह पता चलता है कि कुंजी जोड़े का कौनसा पेज दिखाना है. अगर टोकन नहीं दिया जाता है, तो एपीआई नतीजों का पहला पेज दिखाएगा.
pageSize

integer

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

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

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

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

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
cseKeyPairs[]

object (CseKeyPair)

उपयोगकर्ता के लिए इंस्टॉल किए गए सीएसई के मुख्य जोड़े की सूची का एक पेज.
nextPageToken

string

पेज पर नंबर डालने वाला टोकन, जिसे keypairs.list कॉल में पास किया जाना है, ताकि कुंजी जोड़े का अगला पेज वापस पाया जा सके. अगर यह वैल्यू नहीं मिलती है, तो इसका मतलब है कि अब कोई और पेज नहीं बचा है.

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

इसके लिए, इनमें से किसी एक 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 देखें.