削除¶
POST /api/v1/workspace/accesskey/{ak_uuid}/delete
概要¶
指定した API Key を削除し、AK/SK を無効化します。
呼び出し前の確認と使用手順¶
External 認証情報の w 権限が必要です。まず API Key 一覧 または API Key 詳細 で Key 名と所属ワークスペースを確認し、この認証情報に依存するすべてのクライアントを置き換えてから削除してください。この External パスは UUID で特定し、workspaceUUID を再度渡す必要はなく、ワークスペース全体を削除するパラメータも受け付けません。ソフト削除を実行し、そのロール関連付けをクリーンアップし、AK/SK キャッシュを無効としてマークします。正常な Key および無効化済みだが未削除の非システム Key は処理可能で、Agent にバインドされた Key は拒否されます。存在しない Key、削除済みの Key、システム Key は無視されますが、true を返す場合があります。true によって各対象が元々存在していたと判断することはできません。この操作ではワークスペースや収集 Token は削除されません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ak_uuid | string | Y | API Key レコードの UUID(通常は wsak_ プレフィックス)。ak/sk 呼び出し認証情報ではありません。この External パスは UUID でワークスペースをまたいで特定するため、実行前に workspaceUUID を確認してください。 例: wsak_example001取得または入力方法: API Key 一覧 の content.data[].uuid、または作成成功時の content.uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョン。省略したうえで本ページのアルゴリズムを引き続き使用することはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用し、例の署名アルゴリズムと組み合わせます。 |
|
| X-Df-Access-Key | string | Y | 本モジュールの一覧では r または w 権限を利用できます。それ以外のインターフェース(GET 詳細を含む)には External 認証情報の w 権限が必要です。 例: <external-access-key>取得または入力方法: サイト管理者が割り当てた External API AK を使用します。ワークスペースの OpenAPI Key は使用できません。 |
| X-Df-Nonce | string | Y | 一時的なシリアル番号。失敗して再送する場合も新しい値を生成し、署名を再計算します。 例: 97d275ee9f774315a7885ba7347acbd9取得または入力方法: リクエストごとに uuid.uuid4().hex を再生成します。 |
| X-Df-Signature | string | Y | 大文字のメソッド、nonce、元の完全なパス、timestamp、および元の UTF-8 リクエストボディをスペースで連結した後、HMAC-SHA256 を実行し、hex ダイジェストを取得します。 例: <hmac-sha256-hex>取得または入力方法: External API 署名認証 に従い、対応する SK を使用して計算します。完全に実行可能なテンプレートは以下を参照してください。 |
| X-Df-Timestamp | string | Y | サイトに設定された署名の有効時間枠内である必要があり、例の時刻を再利用できません。 例: 1785427200取得または入力方法: 送信時に str(int(time.time())) で現在の Unix 秒文字列を生成します。 |
パラメータ補足説明¶
サイトレベルの External API AK/SK を使用し、署名方式は External API 署名認証 を参照してください。本ページで生成するワークスペース API Key と External 署名認証情報は同じ認証情報セットではありません。External は現在 AK/SK の平文を返し、フロントエンド画面のマスクポリシーを適用しません。応答例はすべてプレースホルダー値を使用しているため、実際の応答は認証情報として保管してください。削除の取り消しや古い認証情報の復元を行う入口はありません。失敗後はまず Key の状態と実際の認証を確認し、キャッシュ更新の異常だけに基づいて Key がまだ有効であると判断しないでください。
リクエスト例¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 対象サイトのアドレスおよび管理者が割り当てた External API AK/SK に置き換えます。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/workspace/accesskey/wsak_example001/delete'
query = {}
data = None
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
レスポンス¶
HTTP 200、application/json の統一エンベロープで、業務結果は content にあります。External は declaration を自動的に追加せず、リストのページネーションは content.pageInfo にあります。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 固定で成功時に true を返し、対象が存在しない場合、削除済みの場合、システム Key が無視された場合も true です。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては 共通エラー定義 を参照してください。
下表は確認済みのリクエストおよび業務分岐を示します。通常のデータベース/キャッシュ/監査の 5xx は、グローバルラッパーによって ft.InternalServerError になります。書き込みインターフェースがエラーを返した場合、名前、Owner フラグ、ロール、または削除状態がすでに保存されている可能性があるため、まず現在の状態を照会してから次のステップを決定してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたは応答説明 | 処理方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.AgentWorkspaceAKCanNotDelete | 対象が createdWay=agent かつアカウントにバインドされた Key | agent にバインドされた API Key は削除できません | Agent 管理フローでこの認証情報を処理してください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ無効化、監査、または未処理のフィールド異常 | 内部エラー | traceId を保持し、Key の現在の名前、ロール、状態を確認してください。データは先にコミットされてから失敗する可能性があるため、500 だけで未反映とみなすことはできません。 |