マッピングルールの削除(旧互換インターフェース)¶
GET /api/v1/saml/mapping/field/{fdmp_uuid}/delete
概要¶
現在のワークスペースの SSO 属性マッピングを 1 つ削除します。
呼び出し前の確認と使用手順¶
これは旧アドレスとの互換インターフェースであり、現在のソースコードでも実際に登録されています。過去の「2026-05-31 廃止」というコメントは、現在リクエストが禁止されていることを示すものではありません。新規導入ではマッピングルールの削除を優先して使用してください。旧パスは同じコントローラー/リクエストフィールド/レスポンスを踏襲しており、saml プレフィックスを理由に OIDC が除外されることはありません。
本グループは、特定の SSO プロバイダーのログイン attributes を現在のワークスペースのロールにマッピングします。これはデプロイメントプランの LDAP/OIDC の custom_login_mapping およびシステムマッピングとは異なります。ルールを作成してもマッピングは自動的に有効になりません。対応する SSO 設定で isOpenSAMLMapping を有効にする必要があり(本グループの set_disable)、SSO 設定自体も有効である必要があります。
属性名のマッチングは小文字で比較され、値は正規表現/部分一致ではありません。文字列配列は値ごとにマッチングされます。配列でないオブジェクト/数値/null などは先に json.dumps で文字列に変換されますが、配列要素は一律には文字列に変換されません。そのため、IdP 側で安定した文字列属性と文字列配列を優先して使用してください。複数のロールが一致した場合は和集合を取ります。SSO でマッピングを有効にした後、ルールがない/一致しない場合、アカウントがこのワークスペースへ入ることを禁止でき、以降のログイン/切り替え時に古い関連付けが削除されます。単にデフォルトロールを追加するものではありません。書き込み後はワークスペースとメンバーのキャッシュが非同期で更新されるため、既存の SSO セッションの以降のアクセスに影響する可能性があります。次回ログイン時のみに有効になるとは保証できません。
履歴上のエントリーポイントは実際には GET ですが削除の副作用があるため、自動プリフェッチ/ヘルスチェック/盲目的な再試行は行わないでください。このマッピングのみをソフト削除し、ロール/プロバイダーは削除せず、isOpenSAMLMapping も自動的には無効にしません。該当プロバイダーの一致ルールをすべて削除すると、マッピングを有効にした SSO アカウントは以降アクセスできなくなる可能性があります。削除前の監査では旧ロールを解析しますが、ロールレコードがない場合も NotFoundRole になることがあります。送信後は非同期でキャッシュを更新します。エラー時はまず一覧で削除済みかどうかを確認してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| fdmp_uuid | string | Y | sso_ 以外のプロバイダー UUID または lgmp_ カスタムマッピング。 例: fdmp_example取得または入力方法: このワークスペースのマッピング一覧から、削除対象の fdmp_ UUID を取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/saml/mapping/field/fdmp_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除成功は true。存在しない場合、冪等な成功は保証されません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 404 | ft.SamlMappingNoExists | fdmp_uuid に対応する削除されていないマッピングレコードがこのワークスペースに存在しない | 指定された Saml Mapping が見つかりません | このワークスペースのマッピング一覧から fdmp_ UUID を再取得します(sso_ または lgmp_ 以外)。 |
| 404 | ft.NotFoundRole | 入力ロールまたは旧マッピングのターゲット集合に、このワークスペースで参照可能なロールレコードが 1 件も存在しない([] を含む)。変更/削除の監査でも発生する可能性があります | 指定されたロールが見つからないか、ロールは削除済みです | ロール一覧で現在の入力/旧ターゲットを確認し、空の集合をクリア成功とみなさないでください。過去の不正なルールは管理者が修復してから処理してください。 |
| 500 | ft.InternalServerError | 保存された JSON の形状、データベース、または送信後のタスクディスパッチで未処理の例外が発生 | 内部エラー | データベースはすでにコミット済みで、キャッシュタスクのディスパッチに失敗した可能性があります。まず一覧でルール/SSO スイッチを読み戻してから対処し、traceId を保持してください。 |