עטיפה של מפתח פרטי של משתמש. זוהי פעולה עם הרשאות, ורק אדמינים מורשים של שירות רשימת המפתחות של בקרת הגישה (KACLS) יכולים לבצע אותה. ה-API הזה הוא אופציונלי. גם Google וגם לקוח Gmail לא קוראים ל-API הזה. המפרט שסופק הוא המלצה, ולא דרישה.
בקשת HTTP
POST https://BASE_URL/wrapprivatekey
מחליפים את BASE_URL
בכתובת ה-URL הבסיסית.
פרמטרים של נתיב
ללא.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג ב-JSON | |
---|---|
{ "authentication": string, "perimeter_id": string, "private_key": string } |
שדות | |
---|---|
authentication |
JWT שהונפקה על ידי ספק הזהויות (IdP) ומצהירה על זהות המשתמש. ראו אסימוני אימות. |
perimeter_id |
מזהה ההיקף שרוצים להצפין באמצעות המפתח. |
private_key |
מפתח ה-DEK בקידוד base64. גודל מקסימלי: 128 בייטים. |
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה את המפתח הפרטי המאו包.
אם הפעולה נכשלת, מוחזר תגובה מובנית לשגיאה.
ייצוג ב-JSON | |
---|---|
{ "wrapped_private_key": string } |
שדות | |
---|---|
wrapped_private_key |
המפתח הפרטי המקודד ב-base64. גודל מקסימלי: 8KB. |
דוגמה
בדוגמה הזו מוצגות בקשה ותגובה לדוגמה של השיטה wrapprivatekey
.
בקשה
POST https://mykacls.example.org/v1/wrapprivatekey
{
"private_key": "-----BEGIN RSA PRIVATE KEY-----\\nMIIJ......\\n-----END RSA PRIVATE KEY-----",
"perimeter_id": ""
}
תשובה
{
"wrapped_private_key": "LpyCSy5ddy82PIp/87JKaMF4Jmt1KdrbfT1iqpB7uhVd3OwZiu+oq8kxIzB7Lr0iX4aOcxM6HiUyMrGP2PG8x0HkpykbUKQxBVcfm6SLdsqigT9ho5RYw20M6ZXNWVRetFSleKex4SRilTRny38e2ju/lUy0KDaCt1hDUT89nLZ1wsO3D1F3xk8J7clXv5fe7GPRd1ojo82Ny0iyVO7y7h1lh2PACHUFXOMzsdURYFCnxhKAsadccCxpCxKh5x8p78PdoenwY1tnT3/X4O/4LAGfT4fo98Frxy/xtI49WDRNZi6fsL6BQT4vS/WFkybBX9tXaenCqlRBDyZSFhatPQ==",
}