コンテンツにスキップ

ローテーション¶

POST /api/v1/workspace/accesskey/{ak_uuid}/rotate

概要¶

ワークスペースの API Key をローテーションします。

ルートパラメータ¶

パラメータ名	型	必須	説明
ak_uuid	string	Y	ローテーションする API Key の UUID

パラメータ補足説明¶

指定されたワークスペースの API Key に対して、新しい ak/sk を生成します。名前、備考、ロール設定は保持されます。ローテーションが成功すると、古い ak/sk は直ちに無効になります。新しい ak/sk の平文はこのレスポンスでのみ返されるため、呼び出し元は直ちに安全に保存する必要があります。

現在使用中の API Key で自身のローテーション API を呼び出す場合、現在のリクエストは正常に完了します。レスポンス返却後は、返された新しいクレデンシャルを使用して OpenAPI の呼び出しを継続してください。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/accesskey/wsak_xxxxx/rotate' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-raw '{}' \
  --compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "uuid": "wsak_xxxxx",
        "name": "sdk-ak",
        "ak": "new-ak",
        "sk": "new-sk",
        "workspaceUUID": "wksp_xxx",
        "roleInfo": [
            {
                "uuid": "readOnly",
                "name": "Read-only"
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}