削除¶
GET /api/v1/workspace/accesskey/{ak_uuid}/delete
概要¶
現在のワークスペースの API Key をソフト削除し、対応する認証情報を無効化します。
呼び出し前と使用手順¶
現在のワークスペースで workspace.openAPIKeyManage 権限を持つ OpenAPI Key を使用します。ルート宣言には freeEdition バージョン制限が記載されていますが、現在の OpenAPI 認証チェーンではそのバージョンチェックが実行されないため、バージョン自体が必ず 403 になると説明することはできません。可用性はデプロイと実際の権限に応じて確認してください。リソーススコープは常にリクエストヘッダーの Key が属するワークスペースとなり、Body でワークスペースを切り替えることはできません。owner Key では、現在のアイデンティティに owner が含まれることも要求され、API 管理権限だけではこのチェックを代替できません。
これは副作用のある GET エンドポイントです。Web ページのリンク、自動プリフェッチ、ヘルスチェックには含めないでください。すべての利用者が移行済みであることを確認してから、リソース UUID を指定して呼び出してください。システム以外かつ未削除の Key は削除できます。無効化済みの履歴 Key も含まれます。Key と有効なロールの関連付けを削除してからコミットし、その後、古い ak/sk を無効キャッシュとして書き込みます。現在の Key は自身を削除でき、現在のリクエストは終了できます。以降の呼び出しには別の有効な Key を使用する必要があります。
未ヒット(存在しない/別ワークスペース/削除済み/システム Key)でも content=true を返しますが、今回ターゲットを削除したことを証明するものではありません。削除済みの元 UUID で再試行しても、名前で新しい Key を削除することはありません。バインドされたエージェントアカウントに該当し、かつ createdWay=agent の場合は、このエントリポイントからの削除は禁止されています。アカウント専用のフローを使用してください。owner Key には owner アイデンティティが必要です。削除してもワークスペースやアカウントは削除されず、実行開始済みのタスクも取り消されません。
データベースは先にコミットしてからキャッシュを更新します。500 またはタイムアウト時は、別の管理 Key を使用してターゲットとロールの状態を確認し、元の UUID で処理してください。真値によってすべてのノードが即時に無効化されたと判断することはできません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ak_uuid | string | Y | 現在のワークスペースの Key リソース UUID。ak/sk の平文や他のワークスペースの UUID は入力できません。 例: wsak_example取得または入力方法: API Key リスト の content[].uuid、または作成レスポンスの content.uuid から取得します。必要に応じて API Key 詳細 で確認してください。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
副作用のある GET です。削除後は認証情報が無効になります。呼び出し前に利用者を移行し、別の有効な管理 Key を保持してください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/workspace/accesskey/wsak_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 処理完了時は true。未ヒット時も true で、削除件数や Key 情報は返しません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては 共通エラー定義 を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.AgentWorkspaceAKCanNotDelete | accountUUID が空でなく、createdWay=agent のエージェントアカウントにバインドされた認証情報に該当 | agent にバインドされた API Key は削除できません | バインドされたアカウント専用のライフサイクルフローで管理し、アカウント共有の認証情報は削除しないでください。 |
| 403 | ft.Forbidden | 管理権限が不足している、または owner 以外が owner Key を削除している | 操作する権限がありません | 対応する権限と owner アイデンティティを使用してください。 |
| 500 | ft.InternalServerError | データベースまたは認証情報キャッシュの無効化に失敗;ローテーション/削除がコミットされた後にエラーが返された可能性がある | 内部エラー | まず別の有効な管理 Key で元の UUID と状態を読み取ります。ローテーション応答が失われ、かつ古い Key が無効になっている場合は、別の有効な管理 Key を使用して再度ローテーションし、新しい認証情報を安全に受け取ってください。無効になった古い Key で繰り返し再試行しないでください。 |