方法:wrapprivatekey

包裝使用者的私密金鑰。這是具有特殊權限的作業,只能由授權的金鑰存取控制清單 (KACLS) 管理員執行。這個 API 為選用項目。Google 和 Gmail 用戶端都不會呼叫這個 API。提供的規格是建議,而非必要條件。

HTTP 要求

POST https://BASE_URL/wrapprivatekey

BASE_URL 替換成基準網址。

路徑參數

無。

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "authentication": string,
  "perimeter_id": string,
  "private_key": string
}
欄位
authentication

string

識別資訊提供者 (IdP) 宣告使用者的身分所核發的 JWT。請參閱驗證權杖

perimeter_id

string (UTF-8)

要用金鑰加密的範圍 ID。

private_key

string

Base64 編碼的 DEK。大小上限: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==",
}