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

শুধুমাত্র আউটপুট। ক্লায়েন্ট-সাইড এনক্রিপশন S/MIME কী পেয়ারের অপরিবর্তনীয় আইডি।

pkcs7

string

শুধুমাত্র ইনপুট। পাবলিক কী এবং এর সার্টিফিকেট চেইন। চেইনটি অবশ্যই PKCS#7 ফরম্যাটে হতে হবে এবং এতে PEM এনকোডিং ও ASCII আর্মার ব্যবহার করতে হবে।

pem

string

শুধুমাত্র আউটপুট। পাবলিক কী এবং এর সার্টিফিকেট চেইন, PEM ফরম্যাটে।

subjectEmailAddresses[]

string

শুধুমাত্র আউটপুট। লিফ সার্টিফিকেটে নির্দিষ্ট করা ইমেল অ্যাড্রেসের পরিচয়গুলো।

enablementState

enum ( EnablementState )

শুধুমাত্র আউটপুট। কী-পেয়ারটির বর্তমান অবস্থা।

disableTime

string ( Timestamp format)

শুধুমাত্র আউটপুট। যদি কোনো কী পেয়ার DISABLED অবস্থায় সেট করা থাকে, তাহলে সেই সময় যখন কী পেয়ারটির অবস্থা ENABLED থেকে DISABLED এ পরিবর্তিত হয়েছে। এই ফিল্ডটি শুধুমাত্র তখনই উপস্থিত থাকে যখন কী পেয়ারটি DISABLED অবস্থায় থাকে।

RFC 3339 ব্যবহার করা হয়, যেখানে তৈরি হওয়া আউটপুট সর্বদা Z-নরম্যালাইজড হবে এবং এতে ০, ৩, ৬ বা ৯টি ভগ্নাংশীয় অঙ্ক ব্যবহৃত হবে। "Z" ছাড়াও অন্যান্য অফসেটও গ্রহণ করা হয়। উদাহরণ: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" অথবা "2014-10-02T15:01:23+05:30" ।

privateKeyMetadata[]

object ( CsePrivateKeyMetadata )

এই কী পেয়ারের প্রাইভেট কী-এর ইনস্ট্যান্সগুলোর মেটাডেটা।

সক্ষমতা অবস্থা

কী পেয়ারটির বর্তমান অবস্থার গণনা।

এনাম
stateUnspecified কী-পেয়ারটির বর্তমান অবস্থা সেট করা নেই। কী-পেয়ারটি চালুও নয়, বন্ধও নয়।
enabled

কী পেয়ারটি চালু করা আছে। এই কী পেয়ার দ্বারা এনক্রিপ্ট করা যেকোনো ইমেল মেসেজকে Gmail ডিক্রিপ্ট করে এবং প্রাইভেট কী ব্যবহার করে যেকোনো বহির্গামী মেইলে স্বাক্ষর করে।

একটি কী পেয়ার চালু করতে, keypairs.enable মেথডটি ব্যবহার করুন।

disabled

কী পেয়ারটি বন্ধ করা আছে। প্রমাণীকৃত ব্যবহারকারীরা ইমেল বার্তা ডিক্রিপ্ট করতে বা প্রেরিত বার্তায় স্বাক্ষর করতে পারবেন না। যদি কোনো কী পেয়ার ৩০ দিনের বেশি সময় ধরে বন্ধ থাকে, তবে আপনি সেটি স্থায়ীভাবে মুছে ফেলতে পারেন।

একটি কী পেয়ার বন্ধ করতে, 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 Reference দেখুন।

JSON উপস্থাপনা 
{
  "kaclsUri": string,
  "kaclsData": string
}
ক্ষেত্র
kaclsUri

string

যে কী অ্যাক্সেস কন্ট্রোল লিস্ট সার্ভিসটি প্রাইভেট কী পরিচালনা করে, তার URI।

kaclsData

string

কী অ্যাক্সেস কন্ট্রোল লিস্ট সার্ভিস দ্বারা তৈরি ও ব্যবহৃত অস্বচ্ছ ডেটা। সর্বোচ্চ আকার: ৮ কিলোবাইট।

হার্ডওয়্যার কী মেটাডেটা

হার্ডওয়্যার কী-গুলির মেটাডেটা।

যদি গুগল ওয়ার্কস্পেস অর্গানাইজেশনের জন্য হার্ডওয়্যার কী এনক্রিপশন সেট আপ করা থাকে, তবে ব্যবহারকারীরা ঐচ্ছিকভাবে তাদের প্রাইভেট কী স্মার্ট কার্ডে সংরক্ষণ করতে পারেন এবং তাদের উইন্ডোজ ডিভাইসের সাথে সংযুক্ত একটি রিডারে স্মার্ট কার্ডটি প্রবেশ করিয়ে জিমেইলে ইমেল বার্তা সাইন ও ডিক্রিপ্ট করতে পারেন।

JSON উপস্থাপনা 
{
  "description": string
}
ক্ষেত্র
description

string

হার্ডওয়্যার কী-এর বিবরণ।

পদ্ধতি

create

 প্রমাণীকৃত ব্যবহারকারীর জন্য একটি ক্লায়েন্ট-সাইড এনক্রিপশন S/MIME পাবলিক কী সার্টিফিকেট চেইন এবং প্রাইভেট কী মেটাডেটা তৈরি ও আপলোড করে।

disable

 ক্লায়েন্ট-সাইড এনক্রিপশন কী পেয়ার বন্ধ করে দেয়।

enable

 বন্ধ থাকা একটি ক্লায়েন্ট-সাইড এনক্রিপশন কী পেয়ার চালু করে।

get

 বিদ্যমান ক্লায়েন্ট-সাইড এনক্রিপশন কী জোড়া পুনরুদ্ধার করে।

list

 একজন প্রমাণীকৃত ব্যবহারকারীর জন্য ক্লায়েন্ট-সাইড এনক্রিপশন কী জোড়াগুলোর তালিকা দেখায়।

obliterate

 ক্লায়েন্ট-সাইডের এনক্রিপশন কী পেয়ার স্থায়ীভাবে এবং তাৎক্ষণিকভাবে মুছে ফেলে।