REST Resource: users.settings.cse.keypairs

संसाधन: CseKeyPair

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

  • क्लाइंट-साइड एन्क्रिप्शन वाले आउटगोइंग मैसेज पर साइन करें.
  • क्लाइंट-साइड एन्क्रिप्शन वाले मैसेज के ड्राफ़्ट सेव करें और उन्हें फिर से खोलें.
  • भेजे गए मैसेज सेव करें और फिर से खोलें.
  • आने वाले या संग्रहित किए गए S/MIME मैसेज डिक्रिप्ट करें.
जेएसओएन के काेड में दिखाना 
{
  "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 की स्थिति में होता है.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक तक हो सकते हैं. उदाहरण: "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

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

जेएसओएन के काेड में दिखाना 
{
  "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 सीएसई एपीआई का रेफ़रंस देखें.

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

string

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

string

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

HardwareKeyMetadata

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

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

string

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

तरीके

create

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

disable

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

enable

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

get

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

list

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

obliterate

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