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.
pem

string

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

string

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

enum (EnablementState)

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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,

  // 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

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

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

string

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

string

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

HardwareKeyMetadata

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

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

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

string

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

Methods

create

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

disable

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

enable

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

get

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

list

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

obliterate

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