משאב: CseKeyPair
זוג מפתחות S/MIME להצפנה מצד הלקוח, שמורכב ממפתח ציבורי, משרשרת האישורים שלו וממטא-נתונים של המפתח הפרטי המותאם. Gmail משתמש בזוג המפתחות כדי לבצע את המשימות הבאות:
- חתימה על הודעות יוצאות שהוצפנו מצד הלקוח.
- שמירת טיוטות של הודעות מוצפנות מצד הלקוח ופתיחה מחדש שלהן.
- לשמור הודעות שנשלחו ולפתוח אותן מחדש.
- פענוח של הודעות S/MIME נכנסות או הודעות S/MIME שהועברו לארכיון.
ייצוג ב-JSON |
---|
{ "keyPairId": string, "pkcs7": string, "pem": string, "subjectEmailAddresses": [ string ], "enablementState": enum ( |
שדות | |
---|---|
keyPairId |
פלט בלבד. המזהה הבלתי ניתן לשינוי של זוג המפתחות של S/MIME להצפנה מצד הלקוח. |
pkcs7 |
קלט בלבד. המפתח הציבורי ורשת האישורים שלו. השרשרת חייבת להיות בפורמט PKCS#7 ולהשתמש בקידוד PEM ובשריון ASCII. |
pem |
פלט בלבד. המפתח הציבורי ושרשרת האישורים שלו, בפורמט PEM. |
subjectEmailAddresses[] |
פלט בלבד. הזהויות של כתובות האימייל שצוינו בתעודה הבסיסית. |
enablementState |
פלט בלבד. המצב הנוכחי של זוג המפתחות. |
disableTime |
פלט בלבד. אם זוג מפתחות מוגדר כ- הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד 'Z'. דוגמאות: |
privateKeyMetadata[] |
מטא-נתונים למופעים של המפתח הפרטי של זוג המפתחות הזה. |
EnablementState
המניין של המצב הנוכחי של זוג המפתחות.
טיפוסים בני מנייה (enum) | |
---|---|
stateUnspecified |
המצב הנוכחי של זוג המפתחות לא מוגדר. זוג המפתחות לא מופעל ולא מושבת. |
enabled |
זוג המפתחות מופעל. הודעות אימייל שמקודדות על ידי זוג המפתחות הזה מוצפנות על ידי Gmail, והמערכת חותמת על כל אימייל יוצא באמצעות המפתח הפרטי. כדי להפעיל זוג מפתחות, משתמשים בשיטה |
disabled |
זוג המפתחות מושבת. משתמשים מאומתים לא יכולים לפענח הודעות אימייל או לחתום על הודעות יוצאות. אם זוג מפתחות מושבת למשך יותר מ-30 יום, אפשר למחוק אותו לתמיד. כדי להשבית זוג מפתחות, משתמשים בשיטה |
CsePrivateKeyMetadata
מטא-נתונים של מכונה של מפתח פרטי.
ייצוג ב-JSON |
---|
{ "privateKeyMetadataId": string, // Union field |
שדות | |
---|---|
privateKeyMetadataId |
פלט בלבד. המזהה הבלתי ניתן לשינוי של מופע המטא-נתונים של המפתח הפרטי. |
שדה האיחוד metadata_variant . שדה איחוד: חייב להופיע אחד מהסוגים הבאים של וריאנטים של מטא-נתונים. הערך של metadata_variant יכול להיות רק אחת מהאפשרויות הבאות: |
|
kaclsKeyMetadata |
מטא-נתונים של מכונה של מפתח פרטי שמנוהלת על ידי שירות חיצוני של רשימת בקרת גישה למפתחות. |
hardwareKeyMetadata |
מטא-נתונים של מפתחות חומרה. |
KaclsKeyMetadata
מטא-נתונים של מפתחות פרטיים שמנוהלים על ידי שירות חיצוני של רשימת בקרת גישה למפתחות. פרטים על ניהול הגישה למפתחות מופיעים במאמר חומר עזר בנושא Google Workspace CSE API.
ייצוג ב-JSON |
---|
{ "kaclsUri": string, "kaclsData": string } |
שדות | |
---|---|
kaclsUri |
ה-URI של השירות של רשימת המפתחות של בקרת הגישה שמנהל את המפתח הפרטי. |
kaclsData |
נתונים אטומים שנוצרים על ידי שירות רשימת בקרת הגישה למפתחות, ונעשה בהם שימוש בשירות. גודל מקסימלי: 8KiB. |
HardwareKeyMetadata
מטא-נתונים של מפתחות חומרה.
ייצוג ב-JSON |
---|
{ "description": string } |
שדות | |
---|---|
description |
תיאור של מפתח החומרה. |
Methods |
|
---|---|
|
השירות יוצר ומעלה שרשרת של אישורי מפתח ציבורי מסוג S/MIME להצפנה בצד הלקוח, וכן מטא-נתונים של מפתח פרטי עבור המשתמש המאומת. |
|
השבתה של צמד מפתחות להצפנה מצד הלקוח. |
|
הפעלה של זוג מפתחות הצפנה מצד הלקוח שהושבת. |
|
אחזור של זוג מפתחות קיים להצפנה מצד הלקוח. |
|
הצגת רשימה של זוגות מפתחות להצפנה מצד הלקוח של משתמש מאומת. |
|
מחיקה של זוג מפתחות להצפנה מצד הלקוח באופן סופי ומידי. |