コンテンツにスキップ

SSO カスタムマッピングルールの削除



POST /api/v1/login_mapping/field/{lgmp_uuid}/delete

概要

このワークスペースのカスタムログインマッピングルールを 1 件削除します。

呼び出し前の確認と使用手順

このグループは、現在のワークスペースの isSystem=false であるデプロイメントプランのカスタムログイン属性マッピングを管理します。ssoUUID で ID プロバイダーを紐付ける SAML マッピングや、External/Inner のシステムマッピングとは異なります。実際に有効にするには、ワークスペースで isOpenCustomMappingRule を有効化する必要もあります。カスタムマッピング でスイッチを設定し、ログインポリシーを確認できます。保存/削除はルールのみを変更し、既存メンバーのロールを即時に変更せず、既存セッションも取り消しません。後続の LDAP/OIDC 共有ログインフローでは、実際の userinfo に基づいて再マッチングします。

マッチングでは userinfo のトップレベル属性を取得します。配列は要素ごとに str(value) で比較し、その他の値は Python の文字列表現で比較します。フィールドと値にはデータベースの等値セマンティクスを使用し(大文字小文字/照合順序はデプロイ先のデータベースによって決まります)、正規表現/包含一致やネストしたパスの抽出は行いません。ID ソースの安定した文字列のみを使用することを推奨します。複数のマッチングルールのロールは和集合を取得し、その後、利用可能なロールでフィルタリングします。ワークスペースのカスタムスイッチが有効な場合はシステムルールより優先されます。マッチングがある場合は通常ロールをリセットし、マッチングがない場合は元の関連付けをクリアする可能性があります。既存の Owner ロールには保護ロジックがあります。実際の権限は、専用のテスト ID を使用して事前に検証してください。今回の HTTP 成功のみで、次回ログイン時のロールが正しいと判断することはできません。

マッピング設定を論理削除しますが、対象のロールやアカウントは削除せず、メンバーがすでに保持しているロール/セッションも即時に取り消しません。カスタムスイッチが有効な状態で後続のログイン時にマッチングが存在しない場合、元のロール関連付けがクリアされる可能性があるため、削除は「将来のログイン権限を変更しない」ことを意味しません。存在しない場合/別ワークスペース/system または非アクティブなレコードの場合は LoginMappingNoExists を返します。削除前の監査で旧ターゲットロールを解析しますが、旧コレクションが空、または参照可能なレコードがない場合も 404 となり、削除が完了していない可能性があります。タイムアウト/エラーの後は、まず一覧で最終的なレコード状態を確認してから再試行を判断してください。

ルートパラメータ

パラメータ名 型 必須 説明
lgmp_uuid string Y 単一削除では、アクティブな status=0 のオブジェクトのみを操作します。
例: lgmp_example
取得または入力方法: 現在のワークスペースのカスタムマッピング一覧から lgmp_ UUID を取得します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/login_mapping/field/lgmp_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.NotFoundRole 対象/既存のマッピングロール集合に、一致する可視ロールレコードが 1 件もない場合([] を含む)。単一削除または一括削除の監査で旧ロールを解析する際にも発生する可能性があります 指定されたロールが見つからないか、ロールが削除されています まずこのワークスペースのロール一覧とマッピング一覧で確認してください。未知のロールが一部混入している場合はフィルタリングされます。履歴上の空/一致なしの集合は、そのまま削除可能と見なせません。管理者が修復したうえで対応する必要があります。
500 ft.InternalServerError マッピング/ロール/データベースストレージまたはデータフォーマットで未捕捉の例外が発生 内部エラー まず一覧でルールが保存済みか、および最終的な targetValues を確認してから、具体的なフィールドに対応してください。traceId は保持してください。
404 ft.LoginMappingNoExists 単一の UUID が、このワークスペースの isSystem=false かつ status=0 のマッピングに属していない 指定された Login Mapping が見つかりません このワークスペースの一覧から lgmp_ UUID を再取得してください。システムルールまたは非アクティブなレコードは、この単一項目の入口からは操作できません。

フィードバック

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