הפונקציה מחזירה מפתח להצפנת נתונים (DEK) ארוז ונתונים משויכים. אפשר להשתמש בשיטה הזו כדי להצפין נתונים שיובאו בבת אחת ל-Google Drive על ידי אדמין דומיין.
פרטים נוספים זמינים במאמר הצפנה ופענוח של נתונים.
בקשת HTTP
POST https://BASE_URL/privilegedwrap
מחליפים את BASE_URL
בכתובת ה-URL הבסיסית.
פרמטרים של נתיב
ללא.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON | |
---|---|
{ "authentication": string, "key": string, "perimeter_id": string, "reason": string, "resource_name": string } |
שדות | |
---|---|
authentication |
JWT שהונפקה על ידי ספק הזהויות (IdP) ומצהירה על זהות המשתמש. ראו אסימוני אימות. |
key |
מפתח ה-DEK בקידוד base64. גודל מקסימלי: 128 בייטים. |
perimeter_id |
ערך אופציונלי שמקושר למיקום המסמך, שאפשר להשתמש בו כדי לבחור איזה היקף ייבדק בזמן הוצאת המסמך מהאריזה. |
reason |
מחרוזת JSON לצורך העברה (passthrough) שמספקת הקשר נוסף לגבי הפעולה. צריך לנקות את ה-JSON שסופק לפני שהוא מוצג. גודל מקסימלי: 1KB. |
resource_name |
מזהה של האובייקט המוצפן על ידי ה-DEK. |
גוף התשובה
אם הפעולה תצליח, היא תחזיר אובייקט בינארי אטום ש-Google Workspace מאחסן לצד האובייקט המוצפן, ושישלח כפי שהוא בכל פעולת פתיחת מפתחות שבאה לאחר מכן.
אם הפעולה נכשלת, מוחזר תגובה מובנית לשגיאה.
האובייקט הבינארי צריך להכיל את העותק היחיד של ה-DEK המוצפן, וניתן לאחסן בו נתונים ספציפיים להטמעה.
לא לאחסן את ה-DEK במערכת של שירות רשימת המפתחות של בקרת הגישה (KACLS), אלא להצפין אותו ולהחזיר אותו באובייקט wrapped_key
. כך אפשר למנוע אי-התאמות במהלך החיים של המסמך והמפתחות שלו. לדוגמה, כדי לוודא שהנתונים של המשתמש נמחקים לחלוטין כשהוא מבקש זאת, או כדי לוודא שאפשר לפענח גרסאות קודמות ששוחזרו מגיבוי.
ייצוג ב-JSON | |
---|---|
{ "wrapped_key": string } |
שדות | |
---|---|
wrapped_key |
האובייקט הבינארי בקידוד base64. גודל מקסימלי: 1KB. |
דוגמה
בדוגמה הזו מוצגות בקשה ותגובה לדוגמה של השיטה privilegedwrap
.
בקשה
POST https://mykacls.example.com/v1/privilegedwrap
{
"key":"wHrlNOTI9mU6PBdqiq7EQA==",
"resource_name": "wdwqd…",
"authentication": "eyJhbGciOi…",
"reason": "admin import"
}
תשובה
{
"wrapped_key": "3qTh6Mp+svPwYPlnZMyuj8WHTrM59wl/UI50jo61Qt/QubZ9tfsUc1sD62xdg3zgxC9quV4r+y7AkbfIDhbmxGqP64pWbZgFzOkP0JcSn+1xm/CB2E5IknKsAbwbYREGpiHM3nzZu+eLnvlfbzvTnJuJwBpLoPYQcnPvcgm+5gU1j1BjUaNKS/uDn7VbVm7hjbKA3wkniORC2TU2MiHElutnfrEVZ8wQfrCEpuWkOXs98H8QxUK4pBM2ea1xxGj7vREAZZg1x/Ci/E77gHxymnZ/ekhUIih6Pwu75jf+dvKcMnpmdLpwAVlE1G4dNginhFVyV/199llf9jmHasQQuaMFzQ9UMWGjA1Hg2KsaD9e3EL74A5fLkKc2EEmBD5v/aP+1RRZ3ISbTOXvxqYIFCdSFSCfPbUhkc9I2nHS0obEH7Q7KiuagoDqV0cTNXWfCGJ1DtIlGQ9IA6mPDAjX8Lg=="
}