שיטה: wrapprivatekey

עוטף את המפתח הפרטי של המשתמש. זו פעולה שדורשת הרשאות מיוחדות, ורק אדמינים מורשים של שירות רשימת המפתחות של בקרת הגישה (KACLS) יכולים לבצע אותה. השימוש ב-API הזה הוא אופציונלי. לא Google ולא לקוח Gmail קוראים ל-API הזה. המפרט שמופיע כאן הוא המלצה, לא דרישה.

בקשת HTTP

POST https://KACLS_URL/wrapprivatekey

מחליפים את KACLS_URL בכתובת ה-URL של שירות רשימת המפתחות של בקרת הגישה (KACLS).

פרמטרים של נתיב

ללא.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "authentication": string,
  "perimeter_id": string,
  "private_key": string
}
שדות
authentication

string

‫JWT שהונפק על ידי ספק הזהויות (IdP) וכולל הצהרה לגבי זהות המשתמש. ראו אסימוני אימות.
perimeter_id

string (UTF-8)

מזהה ההיקף להצפנה באמצעות המפתח.
private_key

string

מפתח ה-DEK בקידוד Base64. הגודל המקסימלי: 128 בייטים.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה את המפתח הפרטי המוצפן.

אם הפעולה נכשלת, מוחזרת תגובה עם שגיאה מובנית.

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

string

המפתח הפרטי העטוף בקידוד Base64. גודל מקסימלי: ‎8 KB.

דוגמה

בדוגמה הזו מוצגת בקשה ותשובה לדוגמה של שיטת 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==",
}