GET /api/users
Elenca tutti gli utenti

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Elenca tutti gli utenti per il sorgente di autenticazione LDAP

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

GET /api/usergroups/:usergroup_id/users
Elenca tutti gli utenti per gruppo

GET /api/roles/:role_id/users
Elenca tutti gli utenti per il ruolo

GET /api/locations/:location_id/users
Elenca tutti gli utenti per la posizione

GET /api/organizations/:organization_id/users
Elenca tutti gli utenti per l'organizzazione

Esempi

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

Parametri

Nome parametro Descrizione
auth_source_ldap_id
opzionale

ID del sorgente di autenticazione LDAP

Validations:

  • Must be a String
usergroup_id
opzionale

ID gruppo di utenti

Validations:

  • Must be a String
role_id
opzionale

ID ruolo

Validations:

  • Must be a String
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer
organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer
search
opzionale

filtra i risultati

Validations:

  • Must be a String
order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.
per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

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