マッピングルール一覧を取得¶
GET /api/v1/sso_mapping/field/list
概要¶
プロバイダーとキーワードで SSO ロールマッピングルールをページングして読み取ります。
呼び出し前と使用手順¶
本グループは、特定の SSO プロバイダーのログイン attributes を現在のワークスペースのロールにマッピングします。デプロイメントプランの LDAP/OIDC の custom_login_mapping およびシステムマッピングとは異なります。ルールを作成してもマッピングは自動的に有効になりません。対応する SSO 設定で isOpenSAMLMapping を有効にする必要があり(本グループの set_disable)、SSO 設定自体も有効である必要があります。
属性名のマッチングは小文字で比較され、値は正規表現/包含一致ではありません。文字列配列は各値ごとにマッチングされます。配列以外のオブジェクト、数値、null などは先に json.dumps で文字列に変換されますが、配列要素は一律に文字列へ変換されません。そのため、ID プロバイダーで安定した文字列属性および文字列配列の使用を優先してください。複数のロールが一致した場合は和集合を取ります。SSO でマッピングを有効化した後、ルールがない場合や一致しない場合は、アカウントのこのワークスペースへのアクセスを禁止でき、後続のログイン/切り替え時に古い関連付けを削除します。単にデフォルトロールを追加するものではありません。書き込み後はワークスペースとメンバーのキャッシュが非同期に更新されるため、既存の SSO セッションの後続アクセスに影響する可能性があります。次回ログイン時のみ有効になるとは保証できません。
現在のワークスペースの未削除ルールのみを対象とし、デフォルトでは updateAt の降順で並びます。異なるプロバイダーのルールをまとめて一覧表示できます。search はソースフィールド、ソース値、ロール名の間で OR 条件となり、ssoUUID フィルターとは AND 条件になります。ssoInfo={} は、このワークスペースで未削除のプロバイダーが見つからなかったことを示しますが、本 API はこのマッピングを自動的に削除/修復しません。返されるのは設定であり、特定アカウントで現在実際に有効なロールではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 後のあいまい一致。SQL ワイルドカード文字は LIKE に影響する可能性があります。 null 許可: False 例: engineering取得または入力方法: 属性名/値またはロール表示名のキーワードを指定します。 |
|
| ssoUUID | string | 任意、≤48 文字。trim 後に空の場合はフィルターされず、空でない場合は完全一致で絞り込みます。プロバイダーの存在は検証されません。 null 許可: False 最大長: 48 例: sso_example取得または入力方法: このワークスペースの SSO 一覧からプロバイダー UUID を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/sso_mapping/field/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode ssoUUID=sso_example \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> | このページのマッピング配列。 |
| content.data[].id | integer | データベースレコード番号。 |
| content.data[].uuid | string | fdmp_ マッピング UUID。変更/削除に使用します。 |
| content.data[].workspaceUUID | string | 現在のワークスペース。 |
| content.data[].ssoUUID | string | 保存されたプロバイダー UUID。現在も存在する場合や現在のワークスペースに属することを保証しません。 |
| content.data[].sourceField | string | 属性フィールド名。 |
| content.data[].sourceValue | string | 一致するフィールド値。 |
| content.data[].targetValues | array<string> | 保存されたロール識別子の配列。無効になった履歴値が含まれる可能性があります。 |
| content.data[].targetValues[] | string | 単一のロール識別子。 |
| content.data[].roleInfos | array<object> | このワークスペースで参照可能かつ status=0 のロール概要。無効なロールは省略されます。 |
| content.data[].roleInfos[].uuid | string | ロール UUID。 |
| content.data[].roleInfos[].name | string | ロール名。 |
| content.data[].ssoInfo | object | このワークスペースの未削除プロバイダーの概要。有効な一致がない場合は {}。 |
| content.data[].ssoInfo.uuid | string | プロバイダー UUID。省略可能です。 |
| content.data[].ssoInfo.idpName | string | プロバイダー名。省略可能です。 |
| content.data[].status | integer | 未削除レコードのステータス。通常は 0、履歴では 2 の場合があります。 |
| 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": "fdmp_example",
"workspaceUUID": "wksp_example",
"ssoUUID": "sso_example",
"sourceField": "groups",
"sourceValue": "engineering",
"targetValues": [
"general"
],
"roleInfos": [
{
"uuid": "general",
"name": "标准成员"
}
],
"ssoInfo": {
"uuid": "sso_example",
"idpName": "ExampleIdP"
},
"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 | 読み取った履歴 JSON の形状、データベース、またはロール/プロバイダー情報のフォーマットに異常があります | 内部エラー | 特定のプロバイダー/ルールに絞り込み、履歴の targetValues の形状を確認してください。継続的に失敗する場合は traceId を保持してください。 |