削除¶
GET /api/v1/workspace/member_group/{group_uuid}/delete
概要¶
チーム、メンバー、ロールの関連付けを削除し、最後のチーム認可を失った収集Tokenを連動して無効化します。
呼び出し前の確認と使用手順¶
このインターフェースのメソッドはGETですが、実際にチームを削除します。読み取り専用の確認や自動リプレイには使用できません。まずチーム詳細で対象を確認し、そのチームが認可した収集Tokenと、それらのTokenを使用しているデータ収集を確認してください。無効化されるのはそのチームが認可したカスタムTokenのみです。他のチームの認可が残っているTokenは保持されます。チームと関連する紐付けを削除するとキャッシュと非同期権限が更新され、Tokenの同期はコミット後に失敗する可能性があります。存在しないチームを再度削除するとエラーが返され、冪等な成功は保証されません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| group_uuid | string | Y | 対象チームのUUID。現在のワークスペースに属している必要があります。 例: group_example取得・入力方法: チーム一覧の content[].uuid からチームUUIDを取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
409エラーのmessageは失敗段階によって変化します。contentにはcommitted、syncStatus、syncFailureReason、syncRequiresVerification、tokenRecordUUID、isDefaultが含まれる場合があり、存在しないフィールドをfalseとみなすことはできません。既存のToken値はチケットやログに含める必要はありません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/workspace/member_group/group_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | チームの削除処理が完了した場合にtrue。Tokenへの影響の詳細は返されません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.WorkspaceTokenInvalidGroups | 削除前のチェックで、対象チームが存在しない、削除済み、または現在のワークスペースに属していないことが判明 | チームが存在しない、または現在のワークスペースに属していません | チーム一覧から有効なチームUUIDを確認し、存在しない対象を重複して削除しないでください。 |
| 404 | ft.MemberGroupNoExists | 対象チームが存在しない、削除済み、またはこのワークスペースに存在しません | チームが存在しません | チーム一覧から有効なチームUUIDを再コピーしてください。 |
| 401 | ft.WKSPNotExistOrReleased | 対象ワークスペースが存在しない、または利用できません | ワークスペースが存在しません/または解放済みです | 現在のワークスペースの状態を確認し、解放済みのワークスペースに対して再試行しないでください。 |
| 409 | ft.WorkspaceTokenOperationBusy | 同じワークスペースで他のライフサイクル操作が進行中 | 現在のワークスペースで他の操作が進行中です。今回の操作は保存されていません。しばらくしてから再試行してください。 | committed=false の場合は待機してから再試行し、同時削除を避けてください。 |
| 409 | ft.WorkspaceTokenSyncPending | ワークスペースでToken同期が未完了であるか、今回の削除は保存されたもののTokenの後続同期がまだ完了していません | 変更は保存されましたが、同期がまだ完了していません。まず同期の問題に対処してください。今回の操作を重複して送信する必要はありません。 | content.committed を必ず読み取ってください。true の場合は削除済みチームとToken同期を先に確認し、重複して削除しないでください。false の場合は既存の同期を完了してから再試行してください。syncRequiresVerification=true の場合は結果を先に検証する必要があり、盲目的にリプレイすることはできません。 |
| 500 | ft.InternalServerError | Tokenトランザクションのデータベース操作、削除コミット、キャッシュ、または後続の監査が失敗 | 内部エラー | まずチームとTokenの現状を確認し、コミット済みかどうかを確かめてから再試行を判断し、traceIdを保持してください。 |
{
"code": 409,
"content": {
"committed": true,
"syncStatus": "pending",
"syncRequiresVerification": true,
"tokenRecordUUID": "wst_example",
"isDefault": false
},
"errorCode": "ft.WorkspaceTokenSyncPending",
"message": "変更は保存されましたが、前回の同期結果がまだ確認されていません。まず同期結果を検証してください。今回の操作を重複して送信する必要はありません。",
"success": false,
"traceId": "TRACE-EXAMPLE"
}