03-6417-9339

平日 9:30 ～ 12:00 / 13:00 ～ 17:30

users

SIDfmVMサーバに登録されているユーザ一覧を取得するためのエンドポイントです。

エンドポイント users
機能 ユーザ一覧取得
実装バージョン 2.7.0
認証 有り
HTTPメソッド GET/POST

パラメータ

入力値 機能 入力値の型 デフォルト値
q[api_key] パラメータで認証を行う場合に API キーを指定します。
X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 		String なし
q[offset] 取得するデータの先頭位置を指定します。 Number 0
q[per_page] 1～200の値で、1度に取得するデータの数を指定します。指定した値が1～200を超えている場合は10として扱われます。
※全データ数の指定は不可です。 		Number 10
q[order]
一覧データのソート順を指定します。
下記の文字列に_ascを付けると昇順、_descを付けると降順となります。(例: login_asc)
文字列 ソート対象
login ログイン名
lastname 氏名
auth 認証方式
mail_notification メール通知設定
lock ロック
last_login_on 最終ログイン日時
String login_asc
q[filters][login] ログイン名の部分一致で、取得するユーザを絞り込みます。 String なし
q[filters][name] 氏名の部分一致で、取得するユーザを絞り込みます。 String なし
q[filters][auth] 認証方式で、取得するユーザを絞り込みます。
パスワード認証とOpenIDConnect以外は、登録済みの認証方式名を指定します。
パスワード認証とOpenIDConnectを検索する場合は、下記の文字列を指定します。
文字列 検索対象
password パスワード認証
openidconnect OpenIDConnect
String なし
q[filters][role] 権限名で、取得するユーザを絞り込みます。
絞り込み可能な権限名は、下記の通りです。
  • SIDfmVM管理者
  • SIDfmVM報告者
  • SIDfmVM利用者
  • SIDfmVM閲覧者
 String なし
q[filters][category] カテゴリ名で、取得するユーザを絞り込みます。
指定したカテゴリに属するユーザのみに絞り込みます。 		String なし
q[filters][category_group][id] カテゴリグールプのIDで、取得するユーザを絞り込みます。
指定したカテゴリグループに属するユーザのみに絞り込みます。
q[filters][category_group][no_group]と併用して絞り込みすることはできません。 		Number なし
q[filters][category_group][no_group] trueを指定すると、取得するユーザをカテゴリグループに属さないユーザに絞り込みます。
q[filters][category_group][id]と併用して絞り込みすることはできません。 		Boolean なし
q[filters][email_enable] メール通知設定で、取得するユーザを絞り込みます。
trueを指定すると有効のユーザに、falseを指定すると無効のユーザに絞り込みます。 		Boolean なし
q[filters][lock_enable] ユーザのロック状態で、取得するユーザを絞り込みます。
trueを指定するとロック中のユーザに、falseを指定すると未ロックのユーザに絞り込みます。 		Boolean なし
q[filters][login_date_begin] 最終ログイン日時の開始日で、取得するユーザを絞り込みます。
最終ログイン日時が指定した日付以降のユーザに絞り込みます。(例: 2022/11/01)
q[filters][login_date_nologin]と併用して絞り込みすることはできません。 		String なし
q[filters][login_date_end] 最終ログイン日時の終了日で、取得するユーザを絞り込みます。
最終ログイン日時が指定した日付以前のユーザに絞り込みます。(例: 2022/11/01)
q[filters][login_date_nologin]と併用して絞り込みすることはできません。 		String なし
q[filters][login_date_nologin] trueを指定すると、取得するユーザを未ログインのユーザに絞り込みます。
q[filters][login_date_begin]及びq[filters][login_date_end]と併用して絞り込みすることはできません。 		Boolean なし

レスポンス

key value の内容 value の型
success 認証の成否 Boolean
response エラー等の補足情報 Hash
total_size 取得したユーザの数 Number
users ユーザ一覧 Array<Hash>
id ユーザID Number
lastname 姓 String
firstname 名 String
mail_address メールアドレス String
last_login_on 最終ログイン日時 String
auth 認証方式 String
role ユーザ権限 String
email_enable メール通知設定
trueの場合: 有効
falseの場合: 無効 		Boolean
categories ユーザのカテゴリ Array<Hash>
id カテゴリID Number
name カテゴリ名 String
desc 概要 String
hostlim ホスト登録上限数 Number/Null
is_system trueの場合: システムカテゴリ
falseの場合: カスタムカテゴリ 		Boolean
must_change_password 次回ログイン時にパスワード変更を強制
trueの場合: 有効
falseの場合: 無効 		Boolean
lock_enable ロック
trueの場合: ロック
falseの場合: 未ロック 		Boolean
category_groups ユーザのカテゴリグループ Array<Hash>
id カテゴリグループID Number
name カテゴリグループ名 String

レスポンス例

{
  "success": true,
  "response": {},
  "total_size": 85,
  "users": [
    {
      "id": 705,
      "login": "sample",
      "firstname": "sample",
      "lastname": "1",
      "mail_address": "sample@example.com",
      "last_login_on": "2019/12/13 10:10:12",
      "auth": "パスワード認証",
      "role": "SIDfmVM報告者",
      "email_enable": false,
      "categories": [
        {
          "id": 16,
          "name": "サンプルA",
          "desc": "カテゴリサンプルA",
          "hostlim": null,
          "is_system": false
        }
      ],
      "must_change_password": false,
      "lock_enable": false,
      "category_groups": [
        {
          "id": 30,
          "name": "sample"
        }
      ]
    }
  ]
}

サンプルコード

※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM APIキー設定画面で登録済みのAPIキーを設定する必要があります。