Examples

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

Params

Param name Description
auth_source_ldap_id
optional

ID of LDAP authentication source

Validations:

  • Must be a String

usergroup_id
optional

ID of user group

Validations:

  • Must be a String

role_id
optional

ID of role

Validations:

  • Must be a String

location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
admin true, false
auth_source string
auth_source_type string
description text
disabled true, false
firstname string
id integer
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