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

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.