コンテンツにスキップ

SSO 設定の削除(旧互換インターフェース)



GET /api/v1/sso/saml_delete/{sso_uuid}

概要

プロバイダー設定と、その現在のワークスペースとの関連付けを削除します。

呼び出し前の注意事項と使用手順

これは旧アドレスの互換インターフェースであり、現在のソースコードでも実際に登録されています。過去の「2026-05-31 廃止」というコメントは、現在リクエストが禁止されていることを示すものではありません。新規の連携ではSSO 設定の削除を優先して使用してください。旧パスは同じコントローラー/リクエストフィールド/レスポンスを踏襲しており、saml プレフィックスのために OIDC が除外されることはありません。

旧インターフェースは実際には GET ですが削除の副作用があるため、明確に削除する場合にのみ呼び出し、自動プリフェッチ/ヘルスチェックや無闇なリトライは行わないでください。事前に設定をバックアップし、現在の管理者が他に利用可能なログイン手段を保持していることを確認してください。プロバイダーおよび関連付けられたロールマッピングを論理削除し、メールアドレス許可リストのクリーンアップを試みます。IdP 側のクライアント/アカウントは削除されず、リモート設定が取り消されたことを意味するものでもありません。

そのプロバイダーの ID ダイジェストでアカウントを照会し、その後バッチ単位で現在のワークスペースから削除します。これにはメンバーシップ/ロール/メンバーグループ、有効な createdWay=user の個人 Key、ワークスペースのセッショントークン、メンバーキャッシュ/アラートポリシーキャッシュ、チャンネル購読の共有クリーンアップが含まれます。ユーザーアカウント自体およびその他のワークスペースとの関係がこれによってグローバルに削除されることはなく、Key の無効化履歴も今回ですべて削除されることを意味しません。関連付けられたアカウントが現在 Owner である場合、共有クリーンアップは削除を阻止します。

設定をまたぐ処理、メンバーのバッチ単位のコミット、Key/キャッシュ/非同期タスクは単一のアトミック操作ではありません。失敗時には一部の設定やメンバーシップがすでにコミットされている可能性があるため、まず設定およびメンバーの現在の状態を確認し、直ちに再作成しないでください。過去の空の 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/saml_delete/sso_example' \
  -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 ID ダイジェストに関連付けられたアカウントに現在のワークスペースの Owner が含まれており、メンバー削除保護によって拒否された 無効な操作です。所有者を削除できません まず Owner の所属と実際のログイン方法を確認し、権限を持つ管理者が適切に調整したうえで削除してください。
400 ft.AgentMemberCanNotDelete 関連付けられたネームスペースの対象に、共有メンバーのクリーンアップで削除が禁止されているエージェントメンバーが含まれている agent 由来のメンバーは削除できません アカウントのソースと過去の関連付けを確認し、管理者に連絡して処理してください。一部がすでにバッチ単位でコミットされている可能性があります。
500 ft.InternalServerError データベース/関連付けのクリーンアップ、またはコミット後のワークスペース/メンバーキャッシュタスクのディスパッチに失敗した 内部エラー まず get/list で status と関連付けを確認してください。メンバーのクリーンアップはすでにバッチ単位でコミットされている可能性があります。traceId を保持し、このエラーを設定がまったく変更されていないと解釈しないでください。

フィードバック

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