SSO カスタムマッピングルールの一括削除¶
POST /api/v1/login_mapping/field/batch_delete
概要¶
このワークスペースのカスタムログインマッピングルールを一括削除します。
呼び出し前の確認と使用手順¶
このグループは、現在のワークスペースの isSystem=false であるデプロイメントプランのカスタムログイン属性マッピングを管理します。これは、ssoUUID で ID プロバイダーをバインドする SAML マッピングや、External/Inner のシステムマッピングとは異なります。実際に有効にするには、ワークスペースで isOpenCustomMappingRule を有効にする必要があります。カスタムマッピング でスイッチを設定し、ログインポリシーを確認できます。保存/削除はルールのみを変更し、既存メンバーのロールを即時に変更せず、既存セッションも取り消しません。後続の LDAP/OIDC 共有ログインフローでは、実際の userinfo に基づいて再マッチングします。
マッチングでは userinfo のトップレベル属性を取得します。配列は要素ごとに str(value) で比較し、その他の値は Python の文字列表現で比較します。フィールドと値にはデータベースの等値セマンティクスを使用し(大文字と小文字の区別/照合順序はデプロイ先のデータベースにより決定)、正規表現/包含判定やネストしたパス抽出は行いません。ID ソースの安定した文字列のみを使用することを推奨します。複数のマッチングルールのロールは和集合を取り、その後に利用可能なロールをフィルタリングします。ワークスペースのカスタムスイッチが有効な場合はシステムルールより優先されます。マッチングがある場合は通常ロールをリセットし、マッチングがない場合は元の関連付けをクリアする可能性があります。既存の Owner ロールには保護ロジックがあります。実際の権限は、専用のテスト ID を使用して事前に検証してください。今回の HTTP 成功のみで、次回ログイン時のロールが正しいと判断しないでください。
マッピング設定をソフト削除しますが、対象のロールやアカウントは削除せず、メンバーが既に保持しているロール/セッションも即時に取り消しません。後続のログインでカスタムスイッチが有効な場合、マッチングが欠けていると元のロール関係がクリアされる可能性があるため、削除は「将来のログイン権限を変更しない」ことにはなりません。一括処理では、削除対象外のセットに一致した項目のみを処理し、一部の無効な UUID は無視します。ただし、空/すべて未一致、またはすべての旧対象ロールに可視レコードがない場合は NotFoundRole となり、true を項目ごとの削除件数として扱うことはできません。タイムアウト/エラーの後は、まず一覧で最終的なレコード状態を確認してから再試行を判断してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| lgmpUUIDs[*] | string | 旧 YAML の例 fdmp_ はこのグループには適用されません。SAML マッピングのプレフィックスをそのまま使用しないでください。 例: lgmp_example取得または入力方法: 単一の lgmp_ マッピング UUID を取得します。 |
|
| lgmpUUIDs | array | Y | 必須の配列で、空でないことを推奨します。このワークスペースの isSystem=false かつ削除対象外の一致項目のみを処理し、未一致を項目ごとに報告しません。空/すべて未一致の場合は、旧ロールの集計検証で NotFoundRole が報告され、冪等な true にはなりません。 例: ["lgmp_example"]取得または入力方法: 現在のワークスペースのカスタムマッピング一覧から複数の lgmp_ UUID を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/login_mapping/field/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"lgmpUUIDs":["lgmp_example"]}'
レスポンス¶
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 は保持してください。 |
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反しています | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効です | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | Body がオブジェクトではありません | 一部の JSON ファイル形式エラー | lgmpUUIDs 配列を含むオブジェクトを送信してください。 |