REST Resource: users.settings.cse.keypairs

संसाधन: CseKeyPair

क्लाइंट-साइड एन्क्रिप्शन के लिए S/MIME की-पेयर. इसमें सार्वजनिक पासकोड, उसकी सर्टिफ़िकेट चेन, और उससे जुड़ी निजी कुंजी का मेटाडेटा शामिल होता है. Gmail, कुंजी के इस जोड़े का इस्तेमाल इन कामों के लिए करता है:

  • क्लाइंट-साइड एन्क्रिप्शन की मदद से भेजे जाने वाले मैसेज पर हस्ताक्षर करें.
  • क्लाइंट-साइड एन्क्रिप्शन की मदद से एन्क्रिप्ट (सुरक्षित) किए गए मैसेज के ड्राफ़्ट सेव करें और उन्हें फिर से खोलें.
  • भेजे गए मैसेज सेव करना और उन्हें फिर से खोलना.
  • S/MIME से सुरक्षित किए गए, आने वाले या संग्रहित किए गए मैसेज को डिक्रिप्ट करना.

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

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

JSON के काेड में दिखाना 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
फ़ील्ड
keyPairId

string

सिर्फ़ आउटपुट के लिए. क्लाइंट-साइड एन्क्रिप्शन के लिए एस/एमआईएमई कुंजी के जोड़े का ऐसा आईडी जिसे बदला नहीं जा सकता.
pkcs7

string

सिर्फ़ इनपुट के लिए. सार्वजनिक पासकोड और उसकी सर्टिफ़िकेट चेन. चेन, PKCS#7 फ़ॉर्मैट में होनी चाहिए. साथ ही, इसमें PEM एन्कोडिंग और ASCII आर्मर का इस्तेमाल किया जाना चाहिए.
pem

string

सिर्फ़ आउटपुट के लिए. सार्वजनिक पासकोड और उसकी सर्टिफ़िकेट चेन, PEM फ़ॉर्मैट में होनी चाहिए.
subjectEmailAddresses[]

string

सिर्फ़ आउटपुट के लिए. पत्ते के सर्टिफ़िकेट पर दिए गए ईमेल पते की पहचान.
enablementState

enum (EnablementState)

सिर्फ़ आउटपुट के लिए. कुंजी के जोड़े की मौजूदा स्थिति.
disableTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. अगर किसी कुंजी के जोड़े को DISABLED पर सेट किया गया है, तो कुंजी के जोड़े की स्थिति ENABLED से DISABLED में बदलने का समय. यह फ़ील्ड सिर्फ़ तब मौजूद होता है, जब कुंजी का जोड़ा DISABLED स्थिति में हो.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

इस की-पेयर की निजी कुंजी के इंस्टेंस के लिए मेटाडेटा.

EnablementState

यह गिनती, कुंजी के जोड़े की मौजूदा स्थिति के लिए है.

Enums
stateUnspecified कुंजी के मौजूदा जोड़े की स्थिति सेट नहीं है. कुंजी का जोड़ा न तो चालू है और न ही बंद है.
enabled

कुंजी का जोड़ा चालू हो. यह कुंजी जोड़ी जिन ईमेल मैसेज को एन्क्रिप्ट (सुरक्षित) करती है उन्हें Gmail डिक्रिप्ट (सुरक्षित तरीके से खोलना) करता है. साथ ही, भेजे जाने वाले किसी भी ईमेल पर निजी कुंजी से हस्ताक्षर करता है.

की पेयर चालू करने के लिए, keypairs.enable तरीके का इस्तेमाल करें.
disabled

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

किसी की-वैल्यू पेयर को बंद करने के लिए, keypairs.disable तरीके का इस्तेमाल करें.

CsePrivateKeyMetadata

निजी पासकोड के इंस्टेंस के लिए मेटाडेटा.

JSON के काेड में दिखाना 
{
  "privateKeyMetadataId": string,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
फ़ील्ड
privateKeyMetadataId

string

सिर्फ़ आउटपुट के लिए. निजी कुंजी के मेटाडेटा इंस्टेंस के लिए, ऐसा आईडी जिसे बदला नहीं जा सकता.
यूनियन फ़ील्ड metadata_variant. यूनियन फ़ील्ड: मेटाडेटा के इन वैरिएंट टाइप में से सिर्फ़ एक मौजूद होना चाहिए. metadata_variant इनमें से सिर्फ़ एक हो सकता है:
kaclsKeyMetadata

object (KaclsKeyMetadata)

यह मेटाडेटा, निजी पासकोड के उस इंस्टेंस के लिए है जिसे कुंजी ऐक्सेस कंट्रोल लिस्ट (केएसीएल) की सेवा देने वाली बाहरी कंपनी मैनेज करती है.
hardwareKeyMetadata

object (HardwareKeyMetadata)

हार्डवेयर कुंजियों का मेटाडेटा.

KaclsKeyMetadata

कुंजी ऐक्सेस कंट्रोल लिस्ट (केएसीएल) की सेवा देने वाली बाहरी कंपनी की ओर से मैनेज की जाने वाली निजी कुंजियों का मेटाडेटा. कुंजी के ऐक्सेस को मैनेज करने के बारे में ज़्यादा जानने के लिए, Google Workspace CSE API का रेफ़रंस देखें.

JSON के काेड में दिखाना 
{
  "kaclsUri": string,
  "kaclsData": string
}
फ़ील्ड
kaclsUri

string

निजी पासकोड को मैनेज करने वाली, ऐक्सेस कंट्रोल लिस्ट (एसीएल) की सेवा देने वाली कंपनी का यूआरआई.
kaclsData

string

यह ओपेक डेटा है. इसे कुंजी के ऐक्सेस कंट्रोल की सूची वाली सेवा जनरेट और इस्तेमाल करती है. ज़्यादा से ज़्यादा साइज़: 8 किबीबाइट.

HardwareKeyMetadata

हार्डवेयर कुंजियों का मेटाडेटा.

अगर Google Workspace संगठन के लिए हार्डवेयर कुंजी का इस्तेमाल करके एन्क्रिप्शन की सुविधा सेट अप की गई है, तो उपयोगकर्ता चाहें, तो अपनी निजी कुंजी को स्मार्ट कार्ड पर सेव कर सकते हैं. साथ ही, इसका इस्तेमाल Gmail में ईमेल मैसेज पर हस्ताक्षर करने और उन्हें डिक्रिप्ट करने के लिए कर सकते हैं. इसके लिए, उन्हें अपने स्मार्ट कार्ड को Windows डिवाइस से जुड़े रीडर में डालना होगा.

JSON के काेड में दिखाना 
{
  "description": string
}
फ़ील्ड
description

string

हार्डवेयर कुंजी के बारे में जानकारी.

तरीके

create

 यह पुष्टि किए गए उपयोगकर्ता के लिए, क्लाइंट-साइड एन्क्रिप्शन एस/एमआईएमई सार्वजनिक पासकोड सर्टिफ़िकेट चेन और निजी पासकोड मेटाडेटा बनाता है और उसे अपलोड करता है.

disable

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

enable

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

get

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

list

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

obliterate

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