コンテンツにスキップ

メンバー削除



POST /api/v1/workspace/member/batch_delete

概要

現在のワークスペースからメンバーを削除し、直接ロール、チーム、および関連する個人アクセス権限を取り消します。

呼び出し前の確認と使用手順

ワークスペースメンバー一覧から削除するメンバーのUUIDを取得し、業務の引き継ぎを確認してから送信してください。削除は現在のワークスペースのメンバー関係にのみ影響し、サイトアカウント自体は削除しません。オーナー、現在の呼び出し元、およびエージェントメンバーには専用の制限があります。本ワークスペースの直接ロールとチーム関係を取り消し、現在も有効なユーザー個人キーを削除し、メンバーキャッシュと本ワークスペースのログイントークンをクリアし、チャンネル購読を非同期で解除します。元々無効化されている個人キーのレコードは、この削除パスの対象外です。管理コンソールのアカウントグループ経由で継承されたワークスペースアクセスは、管理グループの関係で別途確認する必要があり、この操作をすべての継承認可の一律解除として扱うことはできません。content=null を返し、true ではありません。存在しないメンバー関係では実際の変更がない場合があり、項目ごとの結果は提供されません。メンバー関係、ロール、トークン、キャッシュなどの処理は段階的に保存される場合があります。異常またはタイムアウトが発生した場合は、まずメンバーとロールの状態を読み取り、その後で再試行を判断してください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

リクエストボディパラメータ

パラメータ名 型 必須 説明
accountUUIDs[*] string 配列内の単一文字列識別子。
例: acnt_example
取得または入力方法: ワークスペースメンバー一覧のcontent.data[].uuidから、現在のワークスペースのメンバーアカウントUUIDを取得します。API Key UUIDやメールアドレスではありません。
accountUUIDs array Y 対象アカウントUUIDの配列。同一ワークスペースの実メンバーを指定し、空でない文字列を使用します。
null を許可: False
例: ["acnt_example"]
取得または入力方法: ワークスペースメンバー一覧のcontent.data[].uuidから、現在のワークスペースのメンバーアカウントUUIDを取得します。API Key UUIDやメールアドレスではありません。

パラメータ補足説明

メンバーを削除すると、そのメンバーの本ワークスペースへのアクセスに影響します。成功後は一覧とロールのソースを再読み込みし、直接メンバーと継承関係の最終状態を確認してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/workspace/member/batch_delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"accountUUIDs":["acnt_example"]}'

レスポンス

HTTP 200、application/json。以下の例は、直接参照できる主要フィールドを示します。

フィールド 型 説明
content null 正常なフローでは戻り値はなく、JSONはnullです。項目ごとの削除確認は提供されません。
{
  "code": 200,
  "content": null,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反しています パラメータの解析に失敗しました パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効です リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトではありません 一部の JSON ファイル形式が正しくありません 単一の JSON オブジェクトを送信してください。
400 ft.ForbiddenAdminRemoveSelf 対象リストに現在の呼び出し元の識別情報が含まれています 無効な操作です。管理者は自分自身を削除できません メンバー管理権限を持つ別の識別情報で操作してください。
400 ft.InvalidActionForbiddenRemovalOwner 対象リストにワークスペースのオーナーが含まれています 無効な操作です。オーナーは削除できません 先に手順に従ってオーナーを移譲してください。
400 ft.AgentMemberCanNotDelete 対象アカウントにエージェントメンバーが含まれています エージェント由来のメンバーは削除できません エージェント管理の手順で削除してください。
500 ft.InternalServerError データ保存、関連リソース、またはキャッシュ処理に失敗しました 内部エラー まずメンバーと権限の現在の状態を確認してから再試行を判断してください。失敗が続く場合は、traceId とマスキング済みのリクエストを提供してください。

フィードバック

このページは役に立ちましたか?