GET /api/users
Список всех пользователей

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Список всех пользователей из источника идентификации LDAP

GET /api/usergroups/:usergroup_id/users
Список всех пользователей группы пользователя

GET /api/roles/:role_id/users
Список всех пользователей роли

GET /api/locations/:location_id/users
Список всех пользователей местоположения

GET /api/organizations/:organization_id/users
Список всех пользователей организации

Параметры

Имя параметра Описание
auth_source_ldap_id
необязательно

Код источника идентификации LDAP

Validations:

  • Must be a String

usergroup_id
необязательно

Код группы пользователя

Validations:

  • Must be a String

role_id
необязательно

Код роли

Validations:

  • Must be a String

location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

отсортировать результаты

Validations:

  • Must be a String

page
необязательно

постраничный вывод

Validations:

  • Must be a String

per_page
необязательно

количество записей на запрос

Validations:

  • Must be a String


GET /api/users/:id
Показать пользователя

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be a String


POST /api/users
Создать пользователя

Adds role 'Default role' to the user by default

Параметры

Имя параметра Описание
user
обязательно

Validations:

  • Must be a Hash

user[login]
обязательно

Validations:

  • Must be a String

user[firstname]
необязательно , nil разрешен

Validations:

  • Must be a String

user[lastname]
необязательно , nil разрешен

Validations:

  • Must be a String

user[mail]
обязательно

Validations:

  • Must be a String

user[description]
необязательно , nil разрешен

Validations:

  • Must be a String

user[admin]
необязательно , nil разрешен

это учетная запись администратора

Validations:

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

user[password]
обязательно

Validations:

  • Must be a String

user[default_location_id]
необязательно , nil разрешен

Validations:

  • Must be a Integer

user[default_organization_id]
необязательно , nil разрешен

Validations:

  • Must be a Integer

user[auth_source_id]
обязательно

Validations:

  • Must be a Integer

user[timezone]
необязательно , nil разрешен

Часовой пояс пользователя

Validations:

  • Must be one of: American Samoa, International Date Line West, 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, 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]
необязательно , nil разрешен

Предпочитаемый язык пользователя

Validations:

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

user[role_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type

user[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

user[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type


PUT /api/users/:id
Изменить пользователя

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

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be a String

user
обязательно

Validations:

  • Must be a Hash

user[login]
необязательно

Validations:

  • Must be a String

user[firstname]
необязательно , nil разрешен

Validations:

  • Must be a String

user[lastname]
необязательно , nil разрешен

Validations:

  • Must be a String

user[mail]
необязательно

Validations:

  • Must be a String

user[description]
необязательно , nil разрешен

Validations:

  • Must be a String

user[admin]
необязательно , nil разрешен

это учетная запись администратора

Validations:

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

user[password]
необязательно

Validations:

  • Must be a String

user[default_location_id]
необязательно , nil разрешен

Validations:

  • Must be a Integer

user[default_organization_id]
необязательно , nil разрешен

Validations:

  • Must be a Integer

user[auth_source_id]
необязательно

Validations:

  • Must be a Integer

user[timezone]
необязательно , nil разрешен

Часовой пояс пользователя

Validations:

  • Must be one of: American Samoa, International Date Line West, 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, 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]
необязательно , nil разрешен

Предпочитаемый язык пользователя

Validations:

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

user[role_ids]
необязательно , nil разрешен

Validations:

  • Must be an array of any type

user[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

user[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type

user[current_password]
необязательно , nil разрешен

Required when user want to change own password

Validations:

  • Must be a String


DELETE /api/users/:id
Удалить пользователя

Параметры

Имя параметра Описание
id
обязательно

Validations:

  • Must be a String