यह उपयोगकर्ता की निजी कुंजी को रैप करता है. यह एक खास अधिकार वाली कार्रवाई है. इसे सिर्फ़ कुंजी मैनेज करने वाली सेवा (केएसीएलएस) के अनुमति वाले एडमिन ही कर सकते हैं. इस एपीआई का इस्तेमाल करना ज़रूरी नहीं है. न तो Google और न ही Gmail क्लाइंट, इस एपीआई को कॉल करता है. यहां दी गई खास जानकारी, सुझाव है. यह ज़रूरी नहीं है कि इसका पालन किया जाए.
एचटीटीपी अनुरोध
POST https://KACLS_URL/wrapprivatekey
KACLS_URL को, कुंजी मैनेज करने वाली सेवा (केएसीएलएस) के यूआरएल से बदलें.
पाथ पैरामीटर
कोई नहीं.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:
| JSON के काेड में दिखाना | |
|---|---|
{ "authentication": string, "perimeter_id": string, "private_key": string } |
|
| फ़ील्ड | |
|---|---|
authentication |
पहचान देने वाली सेवा (आईडीपी) की ओर से जारी किया गया JWT. इससे यह पुष्टि होती है कि उपयोगकर्ता कौन है. पुष्टि करने वाले टोकन देखें. |
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=="
}