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

מספר המפתחות של המצב הנוכחי של זוג המפתחות.

טיפוסים בני מנייה (enum)
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 של Google Workspace CSE.

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

string

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

string

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

HardwareKeyMetadata

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

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

string

תיאור של מפתח החומרה.

שיטות

create

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

disable

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

enable

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

get

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

list

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

obliterate

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