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

GET /api/users/:id
Afficher un utilisateur

Exemples

GET /api/users/980190962
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: view_users",
    "missing_permissions": [
      "view_users"
    ]
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be a String


GET /api/current_user
Show the currently logged-in user

Exemples

GET /api/current_user
200
{
  "firstname": "One",
  "lastname": "User",
  "mail": "userone@someware.com",
  "admin": false,
  "auth_source_id": 980190962,
  "auth_source_name": "ldap-server",
  "timezone": null,
  "locale": null,
  "last_login_on": "2009-10-12 21:50:04 UTC",
  "created_at": "2019-11-07 08:36:55 UTC",
  "updated_at": "2019-11-07 08:36:55 UTC",
  "id": 980190962,
  "login": "one",
  "description": null,
  "ssh_keys": [],
  "default_location": null,
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "default_organization": null,
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ],
  "effective_admin": false,
  "cached_usergroups": [],
  "auth_source_ldap": {
    "id": 980190962,
    "type": "AuthSourceLdap",
    "name": "ldap-server"
  },
  "mail_notifications": [],
  "roles": [
    {
      "name": "Viewer",
      "id": 5,
      "description": null,
      "origin": "foreman"
    }
  ],
  "usergroups": []
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer


POST /api/users
Créer un utilisateur

Adds role ‘Default role’ to the user by default

Exemples

POST /api/users
{
  "user": {
    "login": "odjNgdqKOI",
    "auth_source_id": 200482051,
    "password": "123456"
  }
}
201
{
  "firstname": null,
  "lastname": null,
  "mail": null,
  "admin": false,
  "auth_source_id": 200482051,
  "auth_source_name": "Internal",
  "timezone": null,
  "locale": null,
  "last_login_on": null,
  "created_at": "2019-11-07 08:37:05 UTC",
  "updated_at": "2019-11-07 08:37:05 UTC",
  "id": 988725684,
  "login": "odjNgdqKOI",
  "description": null,
  "ssh_keys": [],
  "default_location": null,
  "locations": [],
  "default_organization": null,
  "organizations": [],
  "effective_admin": false,
  "cached_usergroups": [],
  "auth_source_internal": {
    "id": 200482051,
    "type": "AuthSourceInternal",
    "name": "Internal"
  },
  "mail_notifications": [],
  "roles": [],
  "usergroups": []
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

user
requis

Validations:

  • Must be a Hash

user[login]
requis

Validations:

  • Must be a String

user[firstname]
optionel , nil autorisé

Validations:

  • Must be a String

user[lastname]
optionel , nil autorisé

Validations:

  • Must be a String

user[mail]
requis

Validations:

  • Must be a String

user[description]
optionel , nil autorisé

Validations:

  • Must be a String

user[admin]
optionel , nil autorisé

est un compte administrateur

Validations:

  • Must be one of: true, false, 1, 0.

user[password]
optionel , nil autorisé

Obligatoire sauf si l’utilisateur se trouve dans une source d’authentification externe

Validations:

  • Must be a String

user[default_location_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[default_organization_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[auth_source_id]
requis

Validations:

  • Must be a Integer

user[timezone]
optionel , nil autorisé

Fuseau horaire de l’utilisateur

Validations:

  • Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Chihuahua, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Greenland, Montevideo, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..

user[locale]
optionel , nil autorisé

Locale préférée de l’utilisateur

Validations:

  • Must be one of: ca, cs_CZ, de, en, en_GB, es, fr, gl, it, ja, ko, nl_NL, pl, pt_BR, ru, sv_SE, zh_CN, zh_TW.

user[role_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

user[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

user[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type


PUT /api/users/:id
Mise à jour d'un utilisateur

Adds role ‘Default role’ to the user if it is not already present. Only another admin can change the admin account attribute.

Exemples

PUT /api/users/988725687
{
  "user": {
    "mail": "john@example.com",
    "auth_source_id": {
      "auth_source_internal": {
        "id": 200482051,
        "name": "Internal",
        "host": null,
        "port": null,
        "account": null,
        "account_password": null,
        "base_dn": null,
        "attr_login": null,
        "attr_firstname": null,
        "attr_lastname": null,
        "attr_mail": null,
        "onthefly_register": false,
        "tls": false,
        "created_at": "2019-11-07T08:36:55.274Z",
        "updated_at": "2019-11-07T08:36:55.274Z",
        "ldap_filter": null,
        "attr_photo": null,
        "server_type": "posix",
        "groups_base": null,
        "usergroup_sync": true,
        "use_netgroups": false
      }
    },
    "password": "123456"
  }
}
200
{
  "firstname": null,
  "lastname": null,
  "mail": "john@example.com",
  "admin": false,
  "auth_source_id": 980190962,
  "auth_source_name": "ldap-server",
  "timezone": null,
  "locale": null,
  "last_login_on": null,
  "created_at": "2019-11-07 08:37:05 UTC",
  "updated_at": "2019-11-07 08:37:05 UTC",
  "id": 988725687,
  "login": "foo",
  "description": null,
  "ssh_keys": [],
  "default_location": null,
  "locations": [],
  "default_organization": null,
  "organizations": [],
  "effective_admin": false,
  "cached_usergroups": [],
  "auth_source_ldap": {
    "id": 980190962,
    "type": "AuthSourceLdap",
    "name": "ldap-server"
  },
  "mail_notifications": [],
  "roles": [],
  "usergroups": []
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be a String

user
requis

Validations:

  • Must be a Hash

user[login]
optionel

Validations:

  • Must be a String

user[firstname]
optionel , nil autorisé

Validations:

  • Must be a String

user[lastname]
optionel , nil autorisé

Validations:

  • Must be a String

user[mail]
optionel

Validations:

  • Must be a String

user[description]
optionel , nil autorisé

Validations:

  • Must be a String

user[admin]
optionel , nil autorisé

est un compte administrateur

Validations:

  • Must be one of: true, false, 1, 0.

user[password]
optionel , nil autorisé

Obligatoire sauf si l’utilisateur se trouve dans une source d’authentification externe

Validations:

  • Must be a String

user[default_location_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[default_organization_id]
optionel , nil autorisé

Validations:

  • Must be a Integer

user[auth_source_id]
optionel

Validations:

  • Must be a Integer

user[timezone]
optionel , nil autorisé

Fuseau horaire de l’utilisateur

Validations:

  • Must be one of: International Date Line West, American Samoa, Midway Island, Hawaii, Alaska, Pacific Time (US & Canada), Tijuana, Arizona, Chihuahua, Mazatlan, Mountain Time (US & Canada), Central America, Central Time (US & Canada), Guadalajara, Mexico City, Monterrey, Saskatchewan, Bogota, Eastern Time (US & Canada), Indiana (East), Lima, Quito, Atlantic Time (Canada), Caracas, Georgetown, La Paz, Puerto Rico, Santiago, Newfoundland, Brasilia, Buenos Aires, Greenland, Montevideo, Mid-Atlantic, Azores, Cape Verde Is., Casablanca, Dublin, Edinburgh, Lisbon, London, Monrovia, UTC, Amsterdam, Belgrade, Berlin, Bern, Bratislava, Brussels, Budapest, Copenhagen, Ljubljana, Madrid, Paris, Prague, Rome, Sarajevo, Skopje, Stockholm, Vienna, Warsaw, West Central Africa, Zagreb, Zurich, Athens, Bucharest, Cairo, Harare, Helsinki, Jerusalem, Kaliningrad, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Istanbul, Kuwait, Minsk, Moscow, Nairobi, Riyadh, St. Petersburg, Volgograd, Tehran, Abu Dhabi, Baku, Muscat, Samara, Tbilisi, Yerevan, Kabul, Ekaterinburg, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Urumqi, Rangoon, Bangkok, Hanoi, Jakarta, Krasnoyarsk, Novosibirsk, Beijing, Chongqing, Hong Kong, Irkutsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Osaka, Sapporo, Seoul, Tokyo, Yakutsk, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Vladivostok, Magadan, New Caledonia, Solomon Is., Srednekolymsk, Auckland, Fiji, Kamchatka, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..

user[locale]
optionel , nil autorisé

Locale préférée de l’utilisateur

Validations:

  • Must be one of: ca, cs_CZ, de, en, en_GB, es, fr, gl, it, ja, ko, nl_NL, pl, pt_BR, ru, sv_SE, zh_CN, zh_TW.

user[role_ids]
optionel , nil autorisé

Validations:

  • Must be an array of any type

user[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type

user[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type

user[current_password]
optionel , nil autorisé

Nécessaire lorsque l’utilisateur souhaite modifier son propre mot de passe

Validations:

  • Must be a String


DELETE /api/users/:id
Supprimer un utilisateur

Exemples

DELETE /api/users/980190962
{
  "user": {}
}
403
{
  "error": {
    "message": "Access denied",
    "details": "You are trying to delete your own account",
    "missing_permissions": null
  }
}

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requis

Validations:

  • Must be a String