SSO 設定の削除¶
GET /api/v1/sso/{sso_uuid}/delete
概要¶
プロバイダー設定とその現在のワークスペースとの関連付けを削除します。
呼び出し前の確認と使用手順¶
従来のインターフェースは実際には GET ですが削除の副作用があるため、明確に削除する場合にのみ呼び出してください。自動的なプリフェッチやヘルスチェック、無闇なリトライは行わないでください。事前に設定をバックアップし、現在の管理者が他に利用可能なログイン手段を依然として持つことを確認してください。プロバイダーと関連するロールマッピングをソフト削除し、メール許可リストのクリーンアップを試行します。IdP 側のクライアント/アカウントは削除されず、リモート側の設定が取り消されたことを意味するものではありません。
そのプロバイダーのアイデンティティダイジェストでアカウントを検索し、その後バッチ単位で現在のワークスペースから削除します。これにはメンバーシップ/ロール/メンバーグループ、アクティブな createdWay=user の個人キー、ワークスペースセッショントークン、メンバーキャッシュ/アラートポリシーキャッシュ、およびチャンネル購読の共有クリーンアップが含まれます。ユーザーアカウント自体およびその他のワークスペースとの関係は、これによってグローバルに削除されるわけではなく、無効化されたキーの履歴記録も今回すべて消去されることを意味しません。関連アカウントが現在 Owner である場合、共有クリーンアップは削除を阻止します。
設定の横断処理、メンバーのバッチ単位のコミット、キー/キャッシュ/非同期タスクは単一のアトミック操作ではありません。失敗時には一部の設定やメンバー関係がすでにコミットされている可能性があるため、まず設定およびメンバーの現状を確認し、直ちに再構築しないでください。従来の空の idpMd5 分岐ではメンバーのアンバインドとキャッシュタスクをスキップしますが、コントローラーのコンテキスト終了時にすでに削除された内容がコミットされる場合があり、未実行と解釈することはできません。許可リストの旧データおよびクエリの互換性の問題により、すべての残留エントリがクリアされることを保証するものではありません。移行後は実際のログイン確認により再確認してください。needNotify=false はメールのみを抑制します。メール送信の失敗は記録されますが、削除はロールバックされません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| sso_uuid | string | Y | 現在のプロバイダー UUID です。fdmp_ マッピング、IdP ダイジェスト、クライアント ID ではありません。 例: sso_example取得/入力方法: 現在のワークスペースの SSO リスト content[].uuid から削除されていない設定を取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得/入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| needNotify | string | オプションの true/false 文字列で、デフォルトは true です。false はメールのみを抑制し、削除/メンバークリーンアップ/キャッシュ/監査は引き続き実行されます。 null を許可: False 選択可能な値: ['true', 'false'] 例: false取得/入力方法: ワークスペースの Owner/管理者に設定削除の通知を送信するかどうか。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/sso/sso_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode needNotify=false
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.name | string | 処理されたプロバイダーの表示名です。名前が空の場合は空文字列になることがあります。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"name": "ExampleIdP",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストのエラーは共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 406 | ft.NotFoundSAML | UUID が現在のワークスペースの削除されていない SSO 設定に属していない | sso 設定が見つかりません | SSO リストから sso_ UUID を再取得し、fdmp_ マッピングや idpMd5 を使用しないでください。 |
| 400 | ft.InvalidActionForbiddenRemovalOwner | アイデンティティダイジェストに関連するアカウントの中に現在のワークスペースの Owner が存在し、メンバー削除保護により拒否された | 無効な操作です。所有者を削除できません | まず Owner の所属と実際のログイン方法を確認し、権限を持つ管理者が適切に調整した後に削除してください。 |
| 400 | ft.AgentMemberCanNotDelete | 関連する名前空間のターゲットに、共有メンバークリーンアップで削除が禁止されているエージェントメンバーが含まれている | agent 由来のメンバーは削除できません | アカウントのソースと過去の関連を確認し、管理者に連絡してください。一部がすでにバッチ単位でコミットされている可能性があります。 |
| 500 | ft.InternalServerError | データベース/関連クリーンアップ、またはコミット後のワークスペース/メンバーキャッシュタスクの配信に失敗した | 内部エラー | まず get/list で status と関連を確認してください。メンバークリーンアップはすでにバッチ単位でコミットされている可能性があります。traceId を保持し、エラーを設定がまったく変更されていないと解釈しないでください。 |