カスタムマッピングルールの一覧取得¶
GET /api/v1/login_mapping/field/list
概要¶
本ワークスペースのデプロイメントプランのカスタムログインマッピングルールをページ単位で読み取ります。
呼び出し前の準備と使用手順¶
このグループは、現在のワークスペースの isSystem=false であるデプロイメントプランのカスタムログイン属性マッピングを管理します。ssoUUID でアイデンティティプロバイダーをバインドする SAML マッピングや、External/Inner のシステムマッピングとは異なります。実際に有効にするには、ワークスペースで isOpenCustomMappingRule を有効にする必要があります。カスタムマッピングでスイッチを設定し、ログインポリシーを確認できます。保存/削除はルールのみを変更し、既存メンバーのロールを即座に変更せず、既存のセッションも取り消しません。以降の LDAP/OIDC 共有ログインフローでは、実際の userinfo に基づいて再マッチングします。
マッチングは userinfo のトップレベル属性を使用します。配列は要素ごとに str(value) で比較し、それ以外の値は Python の文字列表現で比較します。フィールドと値はデータベースの等値セマンティクス(大文字小文字/照合順序はデプロイ先のデータベースに依存)を使用し、正規表現/包含やネストパスの抽出は行いません。アイデンティティソースの安定した文字列のみを使用することを推奨します。複数のマッチングルールのロールは和集合を取り、その後、利用可能なロールでフィルタリングします。ワークスペースのカスタムスイッチが有効な場合はシステムルールより優先されます。マッチングがある場合は通常ロールをリセットし、マッチングがない場合は既存の関連付けをクリアする可能性があります。既存の Owner ロールには保護ロジックがあります。実際の権限は必ず専用のテストアイデンティティで検証してください。今回の HTTP 成功のみで次回ログイン時のロールが正しいと判断しないでください。
現在のワークスペースの削除されていないカスタムルールのみを読み取り、デフォルトでは最終更新(未更新の場合は作成日時)の降順で並べます。検索はソースフィールド、ソース値、またはロール表示名に同時にマッチングし、ロール名の検索には表示可能な非削除ロールを使用します。roleInfos は status=0 のロールのみを補完するため、検索にヒットしても roleInfos にすべての旧ロールが含まれるとは限りません。ssoUUID によるフィルタリングはなく、このグループは特定のアイデンティティプロバイダーにバインドされません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | 省略可能、デフォルト 1、>=1。 null 許可: False $minValue: 1 例: 1取得または入力方法: 最初のページは 1、以降は pageInfo に従ってページを切り替えます。 |
|
| pageSize | integer | 省略可能、デフォルト 10、単位は件。 null 許可: False $maxValue: 100 $minValue: 1 例: 10取得または入力方法: 必要なページサイズを 1..100 から選択します。 |
|
| search | string | 省略可能、trim 後にキーワードがなければフィルタリングしません。OR マッチングで、SQL のワイルドカード文字が LIKE のセマンティクスに影響する可能性があります。 null 許可: False 例: engineering取得または入力方法: ソース属性名、ソース値、またはターゲットロールの表示名のキーワードを指定します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/login_mapping/field/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> | このページのルール配列。 |
| content.data[].id | integer | レコード番号。 |
| content.data[].uuid | string | lgmp_ マッピング UUID。変更/削除にはこのフィールドを使用し、fdmp_ ではありません。 |
| content.data[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].isSystem | integer または boolean | このグループは固定で 0/false、システムマッピングと区別します。 |
| content.data[].sourceField | string | ログイン属性のトップレベルフィールド名。 |
| content.data[].sourceValue | string | 期待される属性の文字列値。 |
| content.data[].targetValues | array<string> | 保存されたロール集合。ステータス 2 やその後無効になった履歴値を含む可能性があり、現在有効なロールとは異なります。 |
| content.data[].targetValues[] | string | 個々の保存ロール識別子。 |
| content.data[].roleInfos | array<object> | 現在のワークスペースで表示可能かつ status=0 のロールサマリー。無効な項目は省略されます。 |
| content.data[].roleInfos[].uuid | string | 有効なロール識別子。 |
| content.data[].roleInfos[].name | string | ロールの表示名。 |
| content.data[].status | integer | マッピングレコードのステータス。一覧では 3 のみを除外し、その他の履歴ステータスを含む可能性があります。単一操作では 0 のみを受け付けます。 |
| content.data[].creator | string | 作成者の識別子。 |
| content.data[].updator | string | 更新者の識別子。 |
| content.data[].createAt | integer | 作成 Unix 秒。 |
| content.data[].updateAt | integer | 更新 Unix 秒。未更新の場合は -1 になり得ます。 |
| content.data[].deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。 |
| content.declaration | object | 外側の共通宣言。data の各項目に再帰的に付加されません。 |
| pageInfo.pageIndex | integer | 現在のページ。 |
| pageInfo.pageSize | integer | ページサイズ。 |
| pageInfo.count | integer | このページの件数。 |
| pageInfo.totalCount | integer | 検索後のマッチング総数。 |
{
"code": 200,
"content": {
"data": [
{
"id": 1,
"uuid": "lgmp_example",
"workspaceUUID": "wksp_example",
"isSystem": false,
"sourceField": "department",
"sourceValue": "engineering",
"targetValues": [
"general"
],
"roleInfos": [
{
"uuid": "general",
"name": "標準メンバー"
}
],
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427200,
"deleteAt": -1
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータの解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 500 | ft.InternalServerError | マッピング/ロール/データベースストレージまたはデータフォーマットで未捕捉の例外が発生 | 内部エラー | フィルタで特定のルールに絞り込み、過去の targetValues の形状を確認してください。継続的に失敗する場合は traceId を保持してください。 |