GET /api/users
Toon alle gebruikers

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Toon alle gebruikers voor een LDAP authenticatie bron

GET /api/auth_source_externals/:auth_source_external_id/users
List all users for external authentication source

GET /api/usergroups/:usergroup_id/users
Toon alle gebruikers voor een user groep

GET /api/roles/:role_id/users
Toon alle gebruikers voor een rol

GET /api/locations/:location_id/users
Toon alle gebruikers voor een lokatie

GET /api/organizations/:organization_id/users
Toon alle gebruikers voor een organisatie

Examples

GET /api/users
200
{
  "total": 9,
  "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 van de LDAP authenticatie bron

Validations:

  • Must be a String
usergroup_id
Optional

ID van de user groep

Validations:

  • Must be a String
role_id
Optional

ID van de rol

Validations:

  • Must be a String
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer
search
Optional

filter resultaten

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id 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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
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