משאב: CseKeyPair
זוג מפתחות S/MIME עם הצפנה מצד הלקוח, שמורכב ממפתח ציבורי, משרשרת האישורים שלו וממטא-נתונים של המפתח הפרטי המותאם. Gmail משתמש בזוג המפתחות כדי להשלים את המשימות הבאות:
- חתימה על הודעות יוצאות שהוצפנו מצד הלקוח.
- שמירה ופתיחה מחדש של טיוטות של הודעות שהוצפנו מצד הלקוח.
- לשמור ולפתוח מחדש את ההודעות שנשלחו.
- פענוח של הודעות 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 |
פלט בלבד. אם זוג המפתחות מוגדר ל- חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
privateKeyMetadata[] |
מטא-נתונים למופעים של המפתח הפרטי של זוג המפתחות הזה. |
EnablementState
מספר המפתחות של המצב הנוכחי של זוג המפתחות.
טיפוסים בני מנייה (enum) | |
---|---|
stateUnspecified |
המצב הנוכחי של זוג המפתחות לא מוגדר. זוג המפתחות לא מופעל או מושבת. |
enabled |
זוג המפתחות מופעל. בכל הודעת אימייל שזוג המפתחות הזה מצפין, Gmail מפענח את ההודעות ומחתום על כל דואר יוצא באמצעות המפתח הפרטי. כדי להפעיל זוג מפתחות, משתמשים בשיטה |
disabled |
זוג המפתחות מושבת. משתמשים מאומתים לא יכולים לפענח הודעות אימייל או לחתום על הודעות יוצאות. אם זוג המפתחות מושבת במשך יותר מ-30 יום, אתם יכולים למחוק אותו באופן סופי. כדי להשבית זוג מפתחות, משתמשים בשיטה |
CsePrivateKeyMetadata
מטא-נתונים למכונה של מפתח פרטי.
ייצוג JSON |
---|
{ "privateKeyMetadataId": string, // Union field |
שדות | |
---|---|
privateKeyMetadataId |
פלט בלבד. המזהה שלא ניתן לשינוי של מופע המטא-נתונים של המפתח הפרטי. |
שדה איחוד metadata_variant . שדה איחוד: יש לציין בדיוק אחד מסוגי המטא-נתונים הבאים. metadata_variant יכול להיות רק אחת מהאפשרויות הבאות: |
|
kaclsKeyMetadata |
מטא-נתונים למכונה של מפתח פרטי שמנוהלת על ידי שירות חיצוני לניהול רשימות של בקרת גישה למפתחות. |
hardwareKeyMetadata |
מטא-נתונים למפתחות חומרה. |
KaclsKeyMetadata
מטא-נתונים של מפתחות פרטיים שמנוהלים על ידי שירות חיצוני לרישום מפתחות גישה למפתחות. למידע נוסף על ניהול הגישה למפתחות, ראו חומר העזר בנושא API של Google Workspace CSE.
ייצוג JSON |
---|
{ "kaclsUri": string, "kaclsData": string } |
שדות | |
---|---|
kaclsUri |
ה-URI של השירות למפתחות רשימת בקרת הגישה שמנהל את המפתח הפרטי. |
kaclsData |
נתונים אטומים שנוצרו ונמצאים בשימוש על ידי שירות הרשימה של בקרת גישה למפתחות. גודל מקסימלי: 8KiB. |
HardwareKeyMetadata
מטא-נתונים למפתחות חומרה.
ייצוג JSON |
---|
{ "description": string } |
שדות | |
---|---|
description |
תיאור של מפתח החומרה. |
שיטות |
|
---|---|
|
יצירה והעלאה של שרשרת אישורי מפתחות ציבוריים S/MIME של הצפנה מצד הלקוח ומטא-נתונים של מפתח פרטי עבור המשתמש המאומת. |
|
השבתה של זוג מפתחות להצפנה מצד הלקוח. |
|
מפעילה זוג מפתחות הצפנה מצד הלקוח שהושבת. |
|
אחזור של זוג מפתחות קיים להצפנה מצד הלקוח. |
|
רשימה של זוגות מפתחות הצפנה מצד הלקוח של משתמש מאומת. |
|
מחיקה מיידית ומיידית של זוג מפתחות הצפנה מצד הלקוח. |