GET /api/users
Lista wszystkich użytkowników

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Lista wszystkich użytkowników do źródła uwierzytelniania LDAP

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

GET /api/usergroups/:usergroup_id/users
Lista wszystkich użytkowników dla grupy użytkowników

GET /api/roles/:role_id/users
Lista wszystkich użytkowników do roli

GET /api/locations/:location_id/users
Lista wszystkich użytkowników do lokalizacji

GET /api/organizations/:organization_id/users
Lista wszystkich użytkowników w organizacji

Przykłady

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

Parametry

Nazwa parametru Opis
auth_source_ldap_id
opcjonalny

Identyfikator źródła uwierzytelniania LDAP

Validations:

  • Must be a String
usergroup_id
opcjonalny

Identyfikator grupy użytkowników

Validations:

  • Must be a String
role_id
opcjonalny

ID roli

Validations:

  • Must be a String
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer
organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer
search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String
order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.
per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ 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