REST Resource: users.settings.cse.keypairs

संसाधन: CseKeyPair

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

  • क्लाइंट-साइड एन्क्रिप्शन वाले आउटगोइंग मैसेज पर साइन करें.
  • क्लाइंट-साइड एन्क्रिप्शन वाले मैसेज के ड्राफ़्ट सेव करें और फिर से खोलें.
  • भेजे गए मैसेज सेव करना और फिर से खोलना.
  • आने वाले या संग्रहित किए गए S/MIME मैसेज डिक्रिप्ट करें.
JSON के काेड में दिखाना 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
फ़ील्ड
keyPairId

string

सिर्फ़ आउटपुट के लिए. क्लाइंट-साइड एन्क्रिप्शन वाले S/MIME कुंजी के जोड़े के लिए, बदला न जा सकने वाला आईडी.
pkcs7

string

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

string

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

string

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

enum (EnablementState)

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

string (Timestamp format)

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

कुंजी के इस जोड़े की निजी कुंजी के इंस्टेंस का मेटाडेटा.

EnablementState

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

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

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

कुंजी का जोड़ा चालू करने के लिए, keypairs.enable तरीका इस्तेमाल करें.
disabled

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

कुंजी का जोड़ा बंद करने के लिए, keypairs.disable तरीका इस्तेमाल करें.

CsePrivateKeyMetadata

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

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

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
फ़ील्ड
privateKeyMetadataId

string

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

object (KaclsKeyMetadata)

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

object (HardwareKeyMetadata)

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

KaclsKeyMetadata

निजी पासकोड का मेटाडेटा, जिसे बाहरी पासकोड के ऐक्सेस कंट्रोल की सूची देने वाली सेवा मैनेज करती है. कुंजी के ऐक्सेस को मैनेज करने के बारे में जानकारी पाने के लिए, Google Workspace सीएसई (क्लाइंट-साइड एन्क्रिप्शन) एपीआई का रेफ़रंस लेख पढ़ें.

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

string

कुंजी की ऐक्सेस कंट्रोल सूची की सेवा का यूआरआई, जो निजी पासकोड को मैनेज करता है.
kaclsData

string

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

HardwareKeyMetadata

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

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

string

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

तरीके

create

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

disable

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

enable

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

get

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

list

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

obliterate

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