GET /api/users
すべてのユーザーの一覧表示

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
LDAP 認証ソースに対してすべてのユーザーを一覧表示

GET /api/auth_source_externals/:auth_source_external_id/users
外部認証ソースに対してすべてのユーザーを一覧表示

GET /api/usergroups/:usergroup_id/users
ユーザーグループに対してすべてのユーザーを一覧表示

GET /api/roles/:role_id/users
ロールに対してすべてのユーザーを一覧表示

GET /api/locations/:location_id/users
ロケーションに対してすべてのユーザーを一覧表示

GET /api/organizations/:organization_id/users
組織に対してすべてのユーザーを一覧表示

例

GET /api/users
200
{
  "total": 9,
  "subtotal": 0,
  "page": 1,
  "per_page": 20,
  "search": "login == foreman_admin",
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

パラメーター

パラメーター名 記述
auth_source_ldap_id
任意

LDAP 認証ソースの ID

Validations:

  • Must be a String
usergroup_id
任意

ユーザーグループの ID

Validations:

  • Must be a String
role_id
任意

ロールの ID

Validations:

  • Must be a String
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer
organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer
search
任意

結果のフィルター

Validations:

  • Must be a String
order
任意

フィールドと順序のソート (例: ‘id DESC’)

Validations:

  • Must be a String
page
任意

1 から始まるページ番号

Validations:

  • Must be a number.
per_page
任意

戻されるページごとの結果数

Validations:

  • Must be a number.

検索フィールド

フィールド名 タイプ 設定可能な値
admin true, false
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string