マッピングルールの削除¶
GET /api/v1/sso_mapping/field/{fdmp_uuid}/delete
概要¶
現在のワークスペースの SSO 属性マッピングを 1 件削除します。
呼び出し前と使用手順¶
このグループは、特定の SSO プロバイダーのログイン属性を現在のワークスペースのロールにマッピングします。これはデプロイメントプランの LDAP/OIDC の custom_login_mapping およびシステムマッピングとは異なります。ルールを作成してもマッピングは自動的に有効になりません。対応する SSO 設定で isOpenSAMLMapping を有効にする必要があり(本グループの set_disable)、SSO 設定自体も有効である必要があります。
属性名のマッチングは小文字で比較され、値は正規表現/包含一致ではありません。文字列配列は各値ごとに照合されます。配列でないオブジェクト、数値、null などは先に json.dumps で文字列に変換されますが、配列の要素は一律に文字列へ変換されません。そのため、ID ソースで安定した文字列属性および文字列配列を優先して使用してください。複数のロールが一致した場合は和集合を取ります。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/sso_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 を保持してください。 |