メインコンテンツまでスキップ

ユーザー一覧の取得

すべてのユーザーを取得する​

クエリパラメータに何も指定しない場合、すべてのユーザーを取得します。
データ数が多い場合、 offset パラメータと limit パラメータを指定して、一度に取得するデータ数を制限できます。

GET /system/users?offset=0&limit=100

ユーザー名で取得する​

ユーザー名でユーザーを取得する場合、 name パラメータに取得するユーザーのユーザー名を指定します。

GET /system/users?name=岡本 直哉

以下のようなレスポンスが返ります。

Response
{
  "totalCount": 1,
  "data": [
    {
      "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": "システム管理者",
      "avatarUrl": null,
      "canEdit": true,
      "allowLocalAuthentication": false,
      "aclId": "0",
      "permission": -1,
      "id": "21",
      "createdAt": "2023-09-07T07:29:22Z",
      "createdBy": "0",
      "updatedAt": "2023-09-19T10:55:02Z",
      "updatedBy": "21"
    }
  ]
}

所属するプロジェクトの ID で取得する​

所属するプロジェクトの ID でユーザーを取得する場合、 assignedProjectIds パラメータにプロジェクトの ID を指定します。

GET /system/users?assignedProjectIds=47

以下のようなレスポンスが返ります。

Response
{
  "totalCount": 4,
  "data": [
    {
      "name": "岡本 直哉",
      "englishName": "",
      "loginName": "okamoto",
      "email": "",
      "code": "008",
      "organizationName": "開発2課",
      ･･･
    },
    { "name": "黒川 悠太", "englishName": "", "loginName": "kurokawa", ･･･ },
    { "name": "志賀 修造", "englishName": "", "loginName": "shiga", ･･･ },
    { "name": "高畑 哲也", "englishName": "", "loginName": "takahata", ･･･ }
  ]
}

所属する組織の ID または名前で取得する​

所属する組織の ID でユーザーを取得する場合、 organizationIds パラメータに組織の ID を指定します。

GET /system/users?organizationIds=6

また、組織の名前でユーザーを取得する場合、 organizationName パラメータに組織の名前を指定します。

GET /system/users?organizationName=開発1課

どちらも以下のようなレスポンスが返ります。

Response
{
  "totalCount": 5,
  "data": [
    {
      "name": "山本 博",
      "englishName": "",
      "loginName": "yamamoto",
      "organizationName": "開発1課",
      "email": "",
      "code": "002",
      ･･･
    },
    { "name": "藤井 智一", "englishName": "", "loginName": "fujii", "organizationName": "開発1課", ･･･ },
    { "name": "植田 信貴", "englishName": "", "loginName": "ueda", "organizationName": "開発1課", ･･･ },
    { "name": "藤岡 康史", "englishName": "", "loginName": "fujioka", "organizationName": "開発1課", ･･･ },
    { "name": "志賀 修造", "englishName": "", "loginName": "shiga", "organizationName": "開発1課", ･･･ }
  ]
}

所属するユーザーグループの ID または名前で取得する​

所属するユーザーグループの ID でユーザーを取得する場合、 userGroupIds パラメータにユーザーグループの ID を指定します。

GET /system/users?userGroupIds=65

また、ユーザーグループの名前でユーザーを取得する場合、 userGroups パラメータにユーザーグループの名前を指定します。

GET /system/users?userGroups=設計チーム

どちらも以下のようなレスポンスが返ります。

Response
{
  "totalCount": 4,
  "data": [
    {
      "name": "山本 博",
      "englishName": "",
      "loginName": "yamamoto",
      "email": "",
      "code": "002",
      "organizationName": "開発1課",
      ･･･
    },
    { "name": "柴田 智彦", "englishName": "", "loginName": "shibata", ･･･ },
    { "name": "植田 信貴", "englishName": "", "loginName": "ueda", ･･･ },
    { "name": "藤岡 康史", "englishName": "", "loginName": "fujioka", ･･･ }
  ]
}
に最終更新