GET /api/users
Afficher tous les utilisateurs

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Afficher tous les utilisateurs d'une source d'authentification LDAP

GET /api/auth_source_externals/:auth_source_external_id/users
Afficher tous les utilisateurs d'une source d'authentification externe

GET /api/usergroups/:usergroup_id/users
Afficher tous les utilisateurs d'un groupe

GET /api/roles/:role_id/users
Afficher tous les utilisateurs pour un rôle

GET /api/locations/:location_id/users
Afficher tous les utilisateurs d'un emplacement

GET /api/organizations/:organization_id/users
Afficher tous les utilisateurs d'une organisation

Exemples

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

Paramètres

Nom du paramètre Description
auth_source_ldap_id
optionel

ID de la source d’authentification LDAP

Validations:

  • Must be a String
usergroup_id
optionel

ID du groupe d’utilisateurs

Validations:

  • Must be a String
role_id
optionel

ID du rôle

Validations:

  • Must be a String
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: ‘id DESC’

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
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