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": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "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-09-11 14:58:27 UTC",
      "updated_at": "2019-09-11 14:58:27 UTC",
      "id": 980190962,
      "login": "one",
      "description": null,
      "ssh_keys": [],
      "default_location": null,
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1"
        }
      ],
      "default_organization": null,
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1"
        }
      ],
      "effective_admin": false
    },
    {
      "firstname": "Scoped",
      "lastname": "User",
      "mail": "userscoped@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:05 UTC",
      "created_at": "2019-09-11 14:58:27 UTC",
      "updated_at": "2019-09-11 14:58:27 UTC",
      "id": 117925625,
      "login": "scoped",
      "description": null,
      "ssh_keys": [],
      "default_location": null,
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1"
        }
      ],
      "default_organization": null,
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1"
        }
      ],
      "effective_admin": false
    }
  ]
}

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

GET /api/users/:id
Pokaż użytkownika

Przykłady

GET /api/users/980190962
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-09-11 14:58:27 UTC",
  "updated_at": "2019-09-11 14:58:29 UTC",
  "id": 980190962,
  "login": "one",
  "description": null,
  "ssh_keys": [],
  "default_location": {
    "id": 255093256,
    "name": "Location 1",
    "title": "Location 1",
    "description": 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": []
}

Parametry

Nazwa parametru Opis
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

id
wymagany

Validations:

  • Must be a String


POST /api/users
Tworzenie użytkownika

Adds role ‘Default role’ to the user by default

Przykłady

POST /api/users
{
  "user": {
    "login": "foo",
    "auth_source_id": 200482051,
    "password": "123456",
    "role_ids": [
      1,
      3
    ]
  }
}
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-09-11 14:58:29 UTC",
  "updated_at": "2019-09-11 14:58:29 UTC",
  "id": 988725677,
  "login": "foo",
  "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": [
    {
      "name": "Manager",
      "id": 1,
      "description": null,
      "origin": "foreman"
    },
    {
      "name": "View hosts",
      "id": 3,
      "description": null,
      "origin": "foreman"
    }
  ],
  "usergroups": []
}

Parametry

Nazwa parametru Opis
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

user
wymagany

Validations:

  • Must be a Hash

user[login]
wymagany

Validations:

  • Must be a String

user[firstname]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

user[lastname]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

user[mail]
wymagany

Validations:

  • Must be a String

user[description]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

user[admin]
opcjonalny , nil dopuszczalny

Jest to konto administratora

Validations:

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

user[password]
opcjonalny , nil dopuszczalny

Required unless user is in an external authentication source

Validations:

  • Must be a String

user[default_location_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a Integer

user[default_organization_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a Integer

user[auth_source_id]
wymagany

Validations:

  • Must be a Integer

user[timezone]
opcjonalny , nil dopuszczalny

Strefa czasowa użytkownika

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]
opcjonalny , nil dopuszczalny

Korzystne ustawienia regionalne autora

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]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

user[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type

user[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type


PUT /api/users/:id
Aktualizacja użytkownika

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

Przykłady

PUT /api/users/886836129
{
  "user": {
    "login": "qKqMmklNew"
  }
}
200
{
  "firstname": "apiadmin",
  "lastname": "User",
  "mail": "apiadmin@someware.com",
  "admin": true,
  "auth_source_id": 200482051,
  "auth_source_name": "Internal",
  "timezone": null,
  "locale": null,
  "last_login_on": "2009-10-12 21:50:04 UTC",
  "created_at": "2019-09-11 14:58:27 UTC",
  "updated_at": "2019-09-11 14:58:30 UTC",
  "id": 886836129,
  "login": "qKqMmklNew",
  "description": null,
  "ssh_keys": [],
  "default_location": null,
  "locations": [],
  "default_organization": null,
  "organizations": [],
  "effective_admin": true,
  "cached_usergroups": [],
  "auth_source_internal": {
    "id": 200482051,
    "type": "AuthSourceInternal",
    "name": "Internal"
  },
  "mail_notifications": [],
  "roles": [],
  "usergroups": []
}

Parametry

Nazwa parametru Opis
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

id
wymagany

Validations:

  • Must be a String

user
wymagany

Validations:

  • Must be a Hash

user[login]
opcjonalny

Validations:

  • Must be a String

user[firstname]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

user[lastname]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

user[mail]
opcjonalny

Validations:

  • Must be a String

user[description]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

user[admin]
opcjonalny , nil dopuszczalny

Jest to konto administratora

Validations:

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

user[password]
opcjonalny , nil dopuszczalny

Required unless user is in an external authentication source

Validations:

  • Must be a String

user[default_location_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a Integer

user[default_organization_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a Integer

user[auth_source_id]
opcjonalny

Validations:

  • Must be a Integer

user[timezone]
opcjonalny , nil dopuszczalny

Strefa czasowa użytkownika

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]
opcjonalny , nil dopuszczalny

Korzystne ustawienia regionalne autora

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]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

user[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type

user[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type

user[current_password]
opcjonalny , nil dopuszczalny

Required when user want to change own password

Validations:

  • Must be a String


DELETE /api/users/:id
Usuń użytkownika

Przykłady

DELETE /api/users/980190962
{
  "user": {}
}
200
{
  "id": 980190962,
  "login": "one",
  "firstname": "One",
  "lastname": "User",
  "mail": "userone@someware.com",
  "admin": false,
  "last_login_on": "2009-10-12T21:50:04.000Z",
  "auth_source_id": 980190962,
  "created_at": "2019-09-11T14:58:27.192Z",
  "updated_at": "2019-09-11T14:58:27.192Z",
  "password_hash": null,
  "password_salt": null,
  "locale": null,
  "avatar_hash": null,
  "default_organization_id": null,
  "default_location_id": null,
  "lower_login": "one",
  "mail_enabled": true,
  "timezone": null,
  "description": null,
  "password": null,
  "name": "One User"
}

Parametry

Nazwa parametru Opis
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

id
wymagany

Validations:

  • Must be a String