削除¶
POST /api/v1/super-account/delete
概要¶
指定した管理バックエンドアカウントを論理削除します。
呼び出し前の確認と使用手順¶
まず管理バックエンドアカウント一覧で対象および初期スーパー管理者フラグを確認し、ログイン可能な管理アカウントを保持してください。accountUuids の CSV で status=3 を一括でマークし、deleteAt を設定します。通常の業務アカウントやワークスペースは削除しません。現在の削除分岐には無効化分岐の Token クリーンアップがなく、管理アカウント情報のキャッシュも更新されないため、成功レスポンスだけで既存のすべてのセッションが即座に無効化されたと判断することはできません。組織のプロセスに従ってセッション失効を処理し検証したうえで、削除してください。この SYS エントリでは初期スーパー管理者の保護を行わず、不明な UUID や削除済みの UUID は無視されます。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョンです。省略したまま本ページのアルゴリズムを継続使用することはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用し、サンプルの署名アルゴリズムと組み合わせます。 |
|
| X-Df-Access-Key | string | Y | 読み取りインターフェースでは r または w の認証情報を使用でき、書き込みインターフェースでは 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 秒文字列を生成します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| accountUuids | commaArray | Y | 必須の CSV 文字列であり、JSON 配列ではありません。フィールド名は正確に accountUuids と綴ります。サーバー側では直接 split し、先頭と末尾の空白は除去しません。複数の UUID の間にスペースを入れないでください。不明な UUID や削除済みの UUID は無視され、空文字列はどの正常なアカウントにも一致しません。 null を許可: False 例: mact_example001取得または入力方法: 管理バックエンドアカウント一覧の content.data[].uuid から 1 つ以上の管理アカウントを取得し、半角カンマで連結します。 |
パラメータ補足説明¶
認証についてはExternal API 署名認証を参照してください。本モジュールはサイトの管理バックエンドアカウントを管理し、UUID は通常 mact_ です。ワークスペースの業務メンバー acnt_ でも、スペース Owner でもありません。一覧/詳細では r または w 権限を使用でき、それ以外には w 権限が必要です。External は sys の身分で実行され、通常のバックエンドアカウントに対する初期スーパー管理者の操作制限は適用されません。操作前に、対象アカウントと引き続きログイン可能な管理アカウントを確認する必要があります。返却されるのは一致したユーザー名 1 件または空のオブジェクトであり、アカウントごとの削除を証明するものではありません。削除後は一覧/詳細で各アカウントを確認してください。このインターフェースには復元の手段はありません。
リクエスト例¶
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/super-account/delete'
query = {}
data = {'accountUuids': 'mact_example001'}
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 の統一エンベロープです。External は declaration を自動的に付加せず、一覧のページネーションは content.pageInfo にあります。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 返却サマリーであり、アカウントごとの結果ではありません。 |
| content.username | string | 任意: 一致したレコードのいずれか 1 件のログイン名で、順序は保証されません。サマリーの照会時には元々削除済みのアカウントに一致する場合もあり、これに基づいて実際の更新件数を判断することはできません。 |
{
"code": 200,
"content": {
"username": "api-doc-admin"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
一致するレコードがない場合のレスポンス例:
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
本表は現在の External SYS 分岐で到達可能な業務エラーのみを対象としています。通常のバックエンドの実アカウントの自己保護エラーをそのまま流用するものではありません。データベース/キャッシュなどの一般的な 5xx はグローバルに ft.InternalServerError へ統一され、状態や情報が保存された後に失敗する可能性があります。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | 表に従って JSON オブジェクトを送信してください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、監査、または未処理フィールドの異常 | 内部エラー | traceId を保持し、アカウントの現在の情報と状態を確認してください。変更/削除は保存された後に失敗する可能性があります。 |