キーのローテーション
キーリソースを使用して、組織の暗号化キーのローテーション設定に関する情報を取得し、設定を変更します。
キーのローテーション設定を表示または変更するには、キー管理者のロールが必要です。
キーのローテーション間隔設定の取得
キーリソースを使用して、組織の現在のキーのローテーション間隔と有効なキーのローテーション間隔を確認できます。
GET要求
キーのローテーション間隔の詳細を取得するには、次のURIを使用します。
/public/core/v3/key/rotationSettings
GET応答
成功した場合、次の情報を返します。
フィールド | タイプ | 説明 |
|---|
orgId | String | ユーザーが属する組織のID。 |
validRotationIntervals | List <String> | キーの有効なローテーション間隔。現在のキーのローテーション間隔をこれらの値のいずれかに変更するには、PATCH要求を送信します。 |
rotationInterval | String | 組織で使用されているキーの現在のローテーション間隔。 |
GET応答の例
成功した場合、次の例のような応答を受信します。
{
"orgId": "52ZSTB0IDK6dXxaEQLUaQu",
"validRotationIntervals": [
"90_DAYS",
"120_DAYS",
"180_DAYS",
"365_DAYS"
],
"rotationInterval": "365_DAYS"
}
キーのローテーション間隔の変更
キーリソースを使用して、組織のキーローテーション間隔を変更できます。
PATCH要求
キーのローテーション間隔を変更するには、次のURIを使用してPATCH要求を送信します。
/public/core/v3/key/rotationSettings
以下の情報を含めます。
フィールド | タイプ | 必須 | 説明 |
|---|
rotationInterval | String | ○ | 組織で使用するキーのローテーション間隔。以下のいずれかの値を使用します。 - - 90_DAYS
- - 120_DAYS
- - 180_DAYS
- - 365_DAYS
デフォルトは365_DAYSです。 |
PATCH応答
成功したら成功コードを、エラーが発生したらエラーオブジェクトを返します。
PATCHの例
組織のキーのローテーション間隔を変更するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/key/rotationSettings
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"rotationInterval": "120_DAYS"
}