שיטה: wrapprivatekey

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

בקשת HTTP

POST https://BASE_URL/wrapprivatekey

מחליפים את BASE_URL בכתובת ה-URL הבסיסית.

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

ללא.

גוף הבקשה

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

ייצוג 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. גודל מקסימלי: 8KB.

דוגמה

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