REST Resource: users.settings.cse.keypairs

منبع: CseKeyPair

یک جفت کلید رمزگذاری S/MIME سمت کلاینت، که شامل یک کلید عمومی، زنجیره گواهی آن و ابرداده برای کلید خصوصی جفت شده آن است. جیمیل از این جفت کلید برای انجام کارهای زیر استفاده می‌کند:

  • پیام‌های رمزگذاری‌شده‌ی خروجی سمت کلاینت را امضا کنید.
  • ذخیره و بازگشایی پیش‌نویس پیام‌های رمزگذاری‌شده‌ی سمت کلاینت.
  • پیام‌های ارسال شده را ذخیره و دوباره باز کنید.
  • رمزگشایی پیام‌های 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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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

جفت کلید غیرفعال است. کاربران احراز هویت شده نمی‌توانند پیام‌های ایمیل را رمزگشایی کنند یا پیام‌های خروجی را امضا کنند. اگر یک جفت کلید بیش از 30 روز غیرفعال باشد، می‌توانید آن را برای همیشه حذف کنید.

برای غیرفعال کردن یک جفت کلید، از متد keypairs.disable استفاده کنید.

فراداده‌ی CsePrivateKey

فراداده برای یک نمونه کلید خصوصی.

نمایش JSON 
{
  "privateKeyMetadataId": string,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
فیلدها
privateKeyMetadataId

string

فقط خروجی. شناسه تغییرناپذیر برای نمونه فراداده کلید خصوصی.

فیلد Union metadata_variant . فیلد Union: دقیقاً یکی از انواع مختلف متادیتای زیر باید وجود داشته باشد. metadata_variant فقط می‌تواند یکی از موارد زیر باشد:
kaclsKeyMetadata

object ( KaclsKeyMetadata )

فراداده برای یک نمونه کلید خصوصی که توسط یک سرویس فهرست کنترل دسترسی به کلید خارجی مدیریت می‌شود.

hardwareKeyMetadata

object ( HardwareKeyMetadata )

فراداده برای کلیدهای سخت‌افزاری.

فراداده کلید Kacls

فراداده برای کلیدهای خصوصی که توسط یک سرویس لیست کنترل دسترسی به کلید خارجی مدیریت می‌شوند. برای جزئیات بیشتر در مورد مدیریت دسترسی به کلید، به مرجع API CSE فضای کاری گوگل مراجعه کنید.

نمایش JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
فیلدها
kaclsUri

string

آدرس اینترنتی (URI) سرویس فهرست کنترل دسترسی کلید که کلید خصوصی را مدیریت می‌کند.

kaclsData

string

داده‌های مبهم تولید شده و مورد استفاده توسط سرویس لیست کنترل دسترسی کلید. حداکثر اندازه: ۸ کیلوبایت.

فراداده‌ی کلید سخت‌افزار

فراداده برای کلیدهای سخت‌افزاری.

اگر رمزگذاری کلید سخت‌افزاری برای سازمان Google Workspace تنظیم شده باشد، کاربران می‌توانند به صورت اختیاری کلید خصوصی خود را روی کارت هوشمند خود ذخیره کرده و با قرار دادن کارت هوشمند خود در یک دستگاه خوانش متصل به دستگاه ویندوز خود، از آن برای امضا و رمزگشایی پیام‌های ایمیل در Gmail استفاده کنند.

نمایش JSON 
{
  "description": string
}
فیلدها
description

string

توضیحاتی در مورد کلید سخت افزاری

روش‌ها

create

 یک زنجیره گواهی کلید عمومی S/MIME رمزگذاری شده سمت کلاینت و فراداده کلید خصوصی را برای کاربر احراز هویت شده ایجاد و آپلود می‌کند.

disable

 یک جفت کلید رمزگذاری سمت کلاینت را خاموش می‌کند.

enable

 یک جفت کلید رمزگذاری سمت کلاینت را که خاموش بود، فعال می‌کند.

get

 یک جفت کلید رمزگذاری موجود در سمت کلاینت را بازیابی می‌کند.

list

 جفت کلیدهای رمزگذاری سمت کلاینت را برای یک کاربر احراز هویت شده فهرست می‌کند.

obliterate

 یک جفت کلید رمزگذاری سمت کلاینت را به طور دائم و فوری حذف می‌کند.