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 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा 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,

  // 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 CSE API का रेफ़रंस देखें.

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

string

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

string

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

HardwareKeyMetadata

हार्डवेयर बटन के लिए मेटाडेटा.

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

string

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

तरीके

create

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

disable

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

enable

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

get

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

list

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

obliterate

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