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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

מטא-נתונים למפתחות פרטיים המנוהלים על ידי שירות חיצוני של רשימת בקרת גישה למפתחות. לפרטים נוספים על ניהול הגישה למפתחות הצפנה, אפשר לעיין בחומר העזר בנושא CSE API ב-Google Workspace.

ייצוג JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
שדות
kaclsUri

string

ה-URI של שירות רשימת בקרת הגישה למפתחות, שמנהל את המפתח הפרטי.
kaclsData

string

נתונים אטומים שנוצרים ומשמשים את שירות רשימת המפתחות של בקרת הגישה. גודל מקסימלי: 8 KiB.

HardwareKeyMetadata

מטא-נתונים למפתחות חומרה.

ייצוג JSON 
{
  "description": string
}
שדות
description

string

תיאור לגבי מפתח החומרה.

שיטות

create

 יצירה והעלאה של שרשרת אישורים של מפתח ציבורי מסוג S/MIME ומטא-נתונים של מפתח פרטי עבור המשתמש המאומת להצפנה מצד הלקוח.

disable

 משביתה זוג מפתחות להצפנה מצד הלקוח.

enable

 מפעילה זוג מפתחות הצפנה מצד הלקוח שהושבת.

get

 מאחזר זוג מפתחות קיים להצפנה מצד הלקוח.

list

 בתיבת הדו-שיח הזו מפורטים זוגות מפתחות הצפנה מצד הלקוח למשתמשים מאומתים.

obliterate

 מחיקה של זוג מפתחות להצפנה מצד הלקוח באופן קבוע ומיידי.