削除¶
POST /api/v1/mgroup/{group_uuid}/delete
概要¶
バックエンドグループと、そのアカウントおよびワークスペースロールの関連付けを削除します。
呼び出し前の確認と使用手順¶
まずバックエンドグループ一覧で 2 種類の展開を有効にしてすべてのメンバーとワークスペースの認可を確認し、これらのアカウントが当該グループに依存して関連ワークスペースへアクセスしていないことを確かめます。リクエストに Body はありません。group_uuid で有効なバックエンドグループを 1 つ削除します。この操作はグループおよび有効なメンバー/ワークスペースロールの関連付けを論理削除し、関連するワークスペース権限キャッシュを非同期で更新します。アカウントやワークスペースは削除せず、収集 Token も直接無効化しません。アカウントが他の直接的な関連付け/グループを通じて取得している権限は別途確認してください。存在しないグループを重複して削除すると 404 を返します。冪等な成功ではありません。グループ/関連付けの状態が先にコミットされ、その後に権限キャッシュの更新が投入されます。HTTP 200 は、後続のすべてのリクエストが直ちに新しい権限を使用することを保証するものではなく、配信または監査に失敗した 500 が主体の保存後に発生する場合もあります。まず一覧をページングで読み、uuid で特定します。変更時は members/refWorkspaces を完全に展開して確認し、削除時は対象がすでにアクティブ一覧に存在しないかを確認してから再試行を判断してください。更新対象リストが空の場合、共有タスクはすべてのアクティブなワークスペースを更新します。現在のグループのみを更新すると解釈しないでください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| group_uuid | string | Y | 有効なバックエンドグループの UUID。単一ワークスペースの group_ チーム UUID ではありません。 例: mgroup_example001取得または入力方法: バックエンドグループ一覧 の content.data[].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 秒文字列を生成します。 |
パラメータの補足説明¶
サイトレベルの External API AK/SK を使用します。署名方式はExternal API 署名認証を参照してください。バックエンドグループ mgroup_ は複数のワークスペースに関連付けて継承ロールを付与できますが、単一ワークスペース内の group_ チームとは異なる種類のオブジェクトです。書き込みリクエストには w 権限が必要で、一覧では r または w を使用できます。グループと関連付けは先にコミットされるため、後続のキャッシュタスクの配信または監査が失敗すると 500 が返る可能性があります。まず照会して削除済みかどうかを確認してから対処してください。関連するワークスペースがない場合、共有更新タスクは空の対象リストを受け取ると、すべてのアクティブなワークスペースのメンバーキャッシュを更新します。
リクエスト例¶
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/mgroup/mgroup_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。削除されたメンバーやワークスペースの数は返しません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーは共通エラー定義を参照してください。
表には確認済みのリクエストエラーと業務エラーを記載します。通常の内部例外は最終的に 500 ft.InternalServerError になります。グループ/関連付けがすでにコミットされ、後続のキャッシュまたは監査が失敗している可能性があるため、まず現在の状態を読み取り、エラーだけから反映されていないと判断しないでください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 404 | ft.MGroupNoExists | グループ UUID が存在しない、またはグループが削除済み | グループが存在しません | バックエンドグループ一覧から有効な mgroup_ レコードの uuid を取得します。 |
| 500 | ft.InternalServerError | データベース、非同期キャッシュ更新の配信、監査、または未処理のフィールド例外 | 内部エラー | traceId を保存し、一覧からグループ/メンバー/ロールの現在の状態を確認します。データがすでにコミットされている可能性があるため、むやみに重複作成したり全体を上書きしたりしないでください。 |