Skip to content

ユーザー一覧の取得

説明

ユーザーの一覧を取得します。

必要権限

なし

URL

GET /system/users

クエリパラメーター

名前 必須か 説明
name string × ユーザー名
englishName string × ユーザーの英語名
ldapLoginName string × LDAPログイン名
code string × ユーザーのコード
email string × Eメールアドレス
keyword string × キーワード

以下のフィールドに指定したキーワードを持つユーザーを取得します。
・ユーザー名
・ユーザーの英語名
・ユーザーのコード
・所属する組織名
・ログイン名
・LDAPログイン名
・Eメールアドレス
assignedProjectIds string × 所属するプロジェクトのID

指定したプロジェクトに所属するユーザーを取得します。
organizationName string × 所属する組織の名前
organizationIds string × 所属する組織のID

指定した組織及びその配下の組織に所属するユーザーを取得します。
organizations string × 所属する組織

組織の「名前」、「コード」のいずれかに完全一致する組織に所属するユーザーを取得します。
userGroupIds string × 所属するユーザーグループのID

指定したユーザーグループ及びその配下のユーザーグループに所属するユーザーを取得します。
userGroups string × 所属するユーザーグループ

ユーザーグループの「名前」、「コード」のいずれかに完全一致するユーザーグループに所属するユーザーを取得します。
systemRoleIds string × システムロールのID

指定したシステムロールのユーザーを取得します。
systemRole string × システムロール

システムロールの「名前」、「コード」のいずれかに完全一致するシステムロールを持つユーザーを取得します。
includes string × 同時に取得する情報

UserGroups:ユーザーが直接属するユーザグループをを取得します。
Metadata:ユーザー拡張用フィールドを取得します。
includeDeleted boolean × 削除済みデータも取得対象とするか

true:削除されたデータを含めて取得します。
false:削除されていないデータのみを取得します。
isDeleted boolean × includeDeleted =trueのとき有効とします。

true:削除されたデータのみを取得します。
false:削除されていないデータのみを取得します。
limit int × データの最大取得件数
offset int × 何件目のデータから取得するか

省略した場合の既定値は 0 で先頭のデータから取得します。
orderby string × 並び替えに用いるフィールド

フィールド名の後の空白に続けて以下を指定することで、並び替えの順序指定ができます。
asc:昇順(既定値)
desc:降順

レスポンス

名前 説明
totalCount int 検索条件に該当するユーザーの総数
data User[] 取得したユーザー一覧

エラーケース

  • なし

特記事項

コスト閲覧権限がない場合、コスト単価は 0 で取得します。

サンプル

組織名(開発2課)を指定してその組織に所属するユーザーの一覧を取得する

リクエスト
GET /system/users?organizationName=開発2
レスポンス
200 OK

{
  "totalCount":21,
  "data":
  [
    {
      "name":"柴田 智彦",
      "englishName":"",
      "loginName":"shibata",
      "email":"",
      "code":"005",
      "organizationName":"開発2課",
      "language":"ja-JP",
      "timeZone":"Asia/Tokyo",
      "isDeleted":false,
      "unitCost":3000.0,
      "organizationId":"7",
      "timeEntryLockedDate":"2018-11-30T00:00:00",
      "description":"",
      "ldapLoginName":"",
      "systemRoleId":"62",
      "systemRoleName":"担当",
      "canEdit":true,
      "aclId":"0",
      "permission":-1,
      "id":"17",
      "createdAt":"2019-01-10T07:29:22Z",
      "createdBy":"0",
      "updatedAt":"2019-01-07T02:20:01Z",
      "updatedBy":"21"
    },
    {
      "name":"岡本 直哉",
      "englishName":"",
      "loginName":"okamoto",
      "email":"",
      "code":"008",
      "organizationName":"開発2課",
      "language":"ja-JP",
      "timeZone":"Asia/Tokyo",
      "isDeleted":false,
      "unitCost":8000.0,
      "organizationId":"7",
      "timeEntryLockedDate":"1753-01-01T00:00:00",
      "description":"",
      "ldapLoginName":"",
      "systemRoleId":"1",
      "systemRoleName":"システム管理者",
      "canEdit":true,
      "aclId":"0",
      "permission":-1,
      "id":"21",
      "createdAt":"2019-01-10T07:29:22Z",
      "createdBy":"0",
      "updatedAt":"2019-01-22T05:55:24Z",
      "updatedBy":"21"
    },
   .
  .
  .
  ]
}

型定義

User

名前 説明
id string ユーザーID
name string ユーザー名
englishName string ユーザーの英語名
code string ユーザーのコード
description string ユーザーの説明
loginName string ログイン名
ldapLoginName string LDAPログイン名
(ActiveDirectory のみ対応します。)
email string Eメールアドレス
language string 言語
timeZone TimeZone タイムゾーン
unitCost double コスト単価
timeEntryLockedDate Date 実績入力ロックの終了日

このフィールドが 2018/10/5 である場合、2018/10/5 以前の実績入力がロックされていることを表します。
organizationId string 所属する組織のID
organizationName string 所属する組織の名前
systemRoleId string システムロールID
systemRoleName string システムロール名
userGroups UserGroup[] 所属しているユーザーグループ
metadata <string, string> 拡張用メタデータ
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID

UserGroup

名前 説明
id string ユーザーグループID
name string ユーザーグループ名
englishName string ユーザーグループの英語名
code string ユーザーグループのコード
description string ユーザーグループの説明
treePath string ツリーパス
treeDepth int ツリーの深さ
isProjectPrivate boolean プロジェクトグループか
true:プロジェクトで作成したユーザーグループ
false:システムで作成したユーザーグループ
privateProjectId string 所属するプロジェクトID
subGroups UserGroup[] 保持しているサブグループ情報一覧
displayOrder double ユーザーグループの表示順。
UIで表示する際の表示順序を示します。
isDeleted boolean 削除されているか
createdAt DateTime 作成日時
createdBy string 作成者のユーザーID
updatedAt DateTime 更新日時
updatedBy string 更新者のユーザーID

TimeZone(列挙型)

名前 説明
Etc/GMT+12 (UTC-12:00) 国際日付変更線 西側
Etc/GMT+11 (UTC-11:00) 協定世界時-11
America/Adak (UTC-10:00) ハワイ・アリューシャン
Pacific/Honolulu (UTC-10:00) ハワイ
Pacific/Marquesas (UTC-9:30) マルキーズ
America/Anchorage (UTC-09:00) アラスカ
Etc/GMT+9 (UTC-9:00) 協定世界時-9
America/Santa_Isabel (UTC-08:00) バハカリフォルニア
Etc/GMT+8 (UTC-9:00) 協定世界時-8
America/Los_Angeles (UTC-08:00) 太平洋標準時(米国およびカナダ)
America/Phoenix (UTC-07:00) アリゾナ
America/Chihuahua (UTC-07:00) チワワ、ラパス、マサトラン
America/Denver (UTC-07:00) 山地標準時(米国およびカナダ)
Pacific/Easter (UTC-06:00) イースター島
America/Mexico_City (UTC-06:00) グアダラハラ、メキシコシティ、モンテレー
America/Regina (UTC-06:00) サスカチュワン
America/Guatemala (UTC-06:00) 中央アメリカ
America/Chicago (UTC-06:00) 中部標準時(米国およびカナダ)
America/Indiana/Indianapolis (UTC-05:00) インディアナ東部
America/Cancun (UTC-05:00) 東部時間(メキシコ)
America/Port-au-Prince (UTC-05:00) アメリカ東部時間(ハイチ)
America/Havana (UTC-05:00) アメリカ中部時間(キューバ)
America/Bogota (UTC-05:00) ボゴタ、リマ、キト
America/New_York (UTC-05:00) 東部標準時(米国およびカナダ)
America/Asuncion (UTC-04:00) アスンシオン
America/Caracas (UTC-04:30) カラカス
America/Cuiaba (UTC-04:00) クイアバ
America/Santiago (UTC-04:00) サンチアゴ
America/La_Paz (UTC-04:00) ジョージタウン、ラパス、マナウス、サンフアン
America/Grand_Turk (UTC-04:00) 大西洋時間(タークス・カイコス諸島)
America/Halifax (UTC-04:00) 大西洋標準時(カナダ)
America/St_Johns (UTC-03:30) ニューファンドランド
America/Araguaina (UTC-03:00) ブラジル(アラグアイーナ)
America/Cayenne (UTC-03:00) カイエンヌ、フォルタレザ
America/Godthab (UTC-03:00) グリーンランド
America/Bahia (UTC-03:00) ブラジル(バイーア)
America/Miquelon (UTC-03:00) ピエール・ミクロン
America/Buenos_Aires (UTC-03:00) ブエノスアイレス
America/Sao_Paulo (UTC-03:00) ブラジル(サンパウロ)
America/Montevideo (UTC-03:00) モンテビデオ
Etc/GMT+2 (UTC-02:00) 協定世界時-2
Atlantic/Azores (UTC-01:00) アゾレス
Atlantic/Cape_Verde (UTC-01:00) カーボベルデ諸島
Etc/GMT (UTC+00:00) 協定世界時
Africa/Casablanca (UTC+00:00) カサブランカ
Europe/London (UTC+00:00) ダブリン、エジンバラ、リスボン、ロンドン
Atlantic/Reykjavik (UTC+00:00) モンロビア、レイキャビク
Europe/Berlin (UTC+01:00) アムステルダム、ベルリン、ベルン、ローマ、ストックホルム、ウィーン
Africa/Windhoek (UTC+01:00) ウィントフック
Europe/Warsaw (UTC+01:00) サラエボ、スコピエ、ワルシャワ、ザグレブ
Europe/Paris (UTC+01:00) ブリュッセル、コペンハーゲン、マドリード、パリ
Europe/Budapest (UTC+01:00) ベオグラード、ブラチスラバ、ブダペスト、リュブリャナ、プラハ
Africa/Lagos (UTC+01:00) 西中央アフリカ
Europe/Athens (UTC+02:00) アテネ
Asia/Amman (UTC+02:00) アンマン
Asia/Jerusalem (UTC+02:00) エルサレム
Africa/Cairo (UTC+02:00) カイロ
Asia/Gaza (UTC+02:00) ガザ
Europe/Kaliningrad (UTC+02:00) カリーニングラード
Europe/Chisinau (UTC+02:00) キシナウ
Asia/Damascus (UTC+02:00) ダマスカス
Africa/Tripoli (UTC+02:00) トリポリ
Africa/Johannesburg (UTC+02:00) ハラーレ、プレトリア
Asia/Beirut (UTC+02:00) ベイルート
Europe/Kiev (UTC+02:00) ヘルシンキ、キエフ、リガ、ソフィア、タリン、ビリニュス
Europe/Istanbul (UTC+02:00) アテネ、ブカレスト、イスタンブール
Asia/Kuwait (UTC+03:00) クウェート
Africa/Nairobi (UTC+03:00) ナイロビ
Asia/Baghdad (UTC+03:00) バグダッド
Europe/Minsk (UTC+03:00) ミンスク
Europe/Moscow (UTC+04:00) モスクワ、サンクトペテルブルグ、ボルゴグラード
Asia/Tehran (UTC+03:30) テヘラン
Europe/Astrakhan (UTC+04:00) アストラハン
Asia/Dubai (UTC+04:00) アブダビ、マスカット
Europe/Samara (UTC+04:00) サマーラ
Asia/Yerevan (UTC+04:00) エレバン
Asia/Tbilisi (UTC+04:00) トビリシ
Asia/Baku (UTC+04:00) バクー
Indian/Mauritius (UTC+04:00) ポートルイス
Asia/Kabul (UTC+04:30) カブール
Asia/Ashgabat (UTC+05:00) アシガバート
Asia/Karachi (UTC+05:00) イスラマバード、カラチ
Asia/Yekaterinburg (UTC+06:00) エカテリンブルグ
Asia/Colombo (UTC+05:30) スリジャヤワルダナプラコッテ
Asia/Kolkata (UTC+05:30) チェンナイ、コルカタ、ムンバイ、ニューデリー
Asia/Kathmandu (UTC+05:45) カトマンズ
Asia/Almaty (UTC+06:00) アスタナ
Asia/Omsk (UTC+06:00) オムスク
Asia/Dhaka (UTC+06:00) ダッカ
Asia/Rangoon (UTC+06:30) ラングーン
Asia/Krasnoyarsk (UTC+08:00) クラスノヤルスク
Asia/Tomsk (UTC+07:00) トムスク
Asia/Novosibirsk (UTC+07:00) ノヴォシビルスク
Asia/Barnaul (UTC+07:00) バルナウル
Asia/Bangkok (UTC+07:00) バンコク、ハノイ、ジャカルタ
Asia/Hovd (UTC+07:00) ホブド
Asia/Irkutsk (UTC+09:00) イルクーツク
Asia/Ulaanbaatar (UTC+08:00) ウランバートル
Asia/Singapore (UTC+08:00) クアラルンプール、シンガポール
Australia/Perth (UTC+08:00) パース
Asia/Taipei (UTC+08:00) 台北
Asia/Shanghai (UTC+08:00) 北京、重慶、香港特別行政区、ウルムチ
Asia/Pyongyang (UTC+08:30) 平壌
Australia/Eucla (UTC+08:45) オーストラリア中西部
Asia/Seoul (UTC+09:00) ソウル
Asia/Chita (UTC+09:00) チッタ
Asia/Yakutsk (UTC+10:00) ヤクーツク
Asia/Tokyo (UTC+09:00) 大阪、札幌、東京
Australia/Adelaide (UTC+09:30) アデレード
Australia/Darwin (UTC+09:30) ダーウィン
Asia/Vladivostok (UTC+11:00) ウラジオストク
Australia/Sydney (UTC+10:00) キャンベラ、メルボルン、シドニー
Pacific/Port_Moresby (UTC+10:00) グアム、ポートモレスビー
Australia/Brisbane (UTC+10:00) ブリスベン
Australia/Hobart (UTC+10:00) ホバート
Australia/Lord_Howe (UTC+10:30) ロード・ハウ
Asia/Sakhalin (UTC+11:00) サハリン
Pacific/Guadalcanal (UTC+11:00) ソロモン諸島、ニューカレドニア
Asia/Srednekolymsk (UTC+11:00) スレドネコリムスク
Pacific/Norfolk (UTC+11:00) ノーフォーク
Pacific/Bougainville (UTC+11:00) ブーゲンビル
Asia/Magadan (UTC+12:00) マガダン
Asia/Anadyr (UTC+12:00) アナディー
Pacific/Auckland (UTC+12:00) オークランド、ウェリントン
Pacific/Fiji (UTC+12:00) フィジー、マーシャル諸島
Etc/GMT-12 (UTC+12:00) 協定世界時+12
Pacific/Chatham (UTC+12:45) チャタム
Pacific/Apia (UTC+13:00) サモア
Pacific/Tongatapu (UTC+13:00) ヌクアロファ
Pacific/Kiritimati (UTC+14:00) ライン諸島