يُستخدم لتشفير مفتاح المستخدم الخاص. هذه عملية مميّزة، ولا يمكن إجراؤها إلا من قِبل مشرفي خدمة "قائمة التحكّم بالوصول إلى مفاتيح التشفير" (KACLS) المعتمَدين. هذه الواجهة اختيارية. لا تستدعي Google أو برنامج Gmail واجهة برمجة التطبيقات هذه. إنّ المواصفات المقدَّمة هي اقتراح، وليست شرطًا.
طلب 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 |
مفتاح التشفير العمومي المشفَّر بترميز base64 الحد الأقصى للحجم: 128 بايت |
نص الاستجابة
وفي حال نجاحها، تُرجع هذه الطريقة المفتاح الخاص المُلفَّف.
إذا تعذّر إتمام العملية، يتم عرض ردّ خطأ منظَّم.
تمثيل JSON | |
---|---|
{ "wrapped_private_key": string } |
الحقول | |
---|---|
wrapped_private_key |
المفتاح الخاص المشفّر بترميز base64 الحد الأقصى للحجم: 8 كيلوبايت |
مثال
يقدّم هذا المثال نموذج طلب وردّ لطريقة 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==",
}