REST Resource: users.settings.cse.keypairs

משאב: CseKeyPair

זוג מפתחות S/MIME להצפנה מצד הלקוח, שכולל מפתח ציבורי, שרשרת האישורים שלו ומטא-נתונים של המפתח הפרטי התואם. ‫Gmail משתמש בזוג המפתחות כדי לבצע את המשימות הבאות:

  • חתימה על הודעות יוצאות שהוצפנו מצד הלקוח.
  • שמירה ופתיחה מחדש של טיוטות של הודעות מוצפנות מצד הלקוח.
  • שמירה ופתיחה מחדש של הודעות שנשלחו.
  • פענוח של הודעות 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 armor.
pem

string

פלט בלבד. המפתח הציבורי ושרשרת האישורים שלו בפורמט PEM.
subjectEmailAddresses[]

string

פלט בלבד. הזהויות של כתובות האימייל שמצוינות באישור העלה.
enablementState

enum (EnablementState)

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

string (Timestamp format)

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

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

מטא-נתונים של מופעים של המפתח הפרטי של זוג המפתחות הזה.

EnablementState

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

טיפוסים בני מנייה (enum)
stateUnspecified המצב הנוכחי של צמד המפתחות לא מוגדר. צמד המפתחות לא מופעל ולא מושבת.
enabled

זוג המפתחות מופעל. לכל הודעות האימייל שהמפתח הזה מצפין, מערכת Gmail מפענחת את ההודעות וחותמת על כל אימייל יוצא באמצעות המפתח הפרטי.

כדי להפעיל זוג מפתחות, משתמשים בשיטה keypairs.enable.
disabled

זוג המפתחות מושבת. משתמשים מאומתים לא יכולים לפענח הודעות אימייל או לחתום על הודעות יוצאות. אם זוג מפתחות מושבת למשך יותר מ-30 יום, אפשר למחוק אותו באופן סופי.

כדי להשבית צמד מפתחות, משתמשים בשיטה 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

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

HardwareKeyMetadata

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

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

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

string

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

Methods

create

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

disable

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

enable

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

get

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

list

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

obliterate

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