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 باشد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "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

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

نمایندگی JSON
{
  "kaclsUri": string,
  "kaclsData": string
}
زمینه های
kaclsUri

string

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

kaclsData

string

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

HardwareKey Metadata

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

نمایندگی JSON
{
  "description": string
}
زمینه های
description

string

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

مواد و روش ها

create

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

disable

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

enable

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

get

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

list

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

obliterate

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