システムユーザー一覧の検索

システムユーザーの情報を検索し、一覧で返却する

📬 リクエスト

GET {resource_api_url}/system-users

リクエストヘッダ

キー	値
Authorization	Bearer {アクセストークン}

パスパラメータ

なし

クエリパラメータ

パラメータ	形式	必須	説明	値の例
fields	文字列	YES	返却対象のフィールド名（カンマ区切り）	id, user_name, is_active
filter	filterパラメータオブジェクト	NO	検索条件	{ "and": [ { "field": "industry", "operator": "eq", "value": "public_admin" } ] }
order_by	オブジェクトの配列	NO	検索結果のソート条件	[{ field: "id", direction: "asc" }]
limit	整数値	NO	1回のリクエストで取得する最大システムユーザー数	100
offset	整数値	NO	取得開始位置（スキップするシステムユーザー数）	0

「order_by」パラメータの構成要素

フィールド	形式	必須	説明	値の例
field	文字列	YES	ソート対象のフィールド名	id
direction	asc （昇順） desc （降順）	NO	ソート方向（省略時は昇順扱い）	asc

✨ 成功レスポンス

ステータスコード

200 : OK

レスポンスヘッダ

キー	値
Content-Type	application/json

レスポンスボディ

フィールド	形式	必須	説明	値の例
has_next_page	真偽値	YES	検索結果に対して、次ページが存在するかどうか	true
total_size	整数値	YES	検索条件に合致するシステムユーザー総数	371
data	単一システムユーザーの取得 - レスポンスボディと同内容の配列	YES	検索結果	[ { "id": "user-00000001", "user_name": "yosuke-tahara@example.com", "first_name": "陽介", ... }, { "id": "user-00000002", "user_name": "akemi-matsushita@example.com", "first_name": "明美", ... }, ... ]

レスポンスボディのサンプル

レスポンスボディのサンプル

{
  "has_next_page": true,
  "total_size": 371,
  "data": [
    {
      "id": "user-00000001",
      "user_name": "yosuke-tahara@example.com",
      "first_name": "陽介",
      "last_name": "田原",
      "email": "yosuke-tahara@example.com",
      "timezone": "Asia/Tokyo",
      "locale": "ja-JP",
      "profile_name": "admin",
      "role_name": "west_japan_sales_department",
      "is_active": true,
      "created_at": "2025-01-01T00:00:00Z",
      "modified_at": "2025-01-01T00:00:00Z"
    },
    {
      "id": "user-00000002",
      "user_name": "akemi-matsushita@example.com",
      "first_name": "明美",
      "last_name": "松下",
      "email": "akemi-matsushita@example.com",
      "timezone": "Asia/Tokyo",
      "locale": "ja-JP",
      "profile_name": "standard_user",
      "role_name": "central_japan_sales_department",
      "is_active": true,
      "created_at": "2025-02-03T04:05:06Z",
      "modified_at": "2025-06-05T04:03:02Z"
    },
    ...
  ]
}

💬 具体的な要求事項

• 基本的な検索要件については、レコード一覧の検索を参考にし、同等の実装を行ってください
  • クエリパラメータ内で使用されるフィールドは、 単一システムユーザーの取得 - レスポンスボディに記載のフィールドが対象となります
• UPWARDを使用する可能性がないユーザーは返却対象から除外しても構いません
  • これは「現在UPWARDを利用中のユーザーのみを返却する」という意味ではありません
  • 今後UPWARDの利用が見込まれるユーザーは対象に含めてください

📚 参考資料

• レコード一覧の検索
• filterパラメータ仕様