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 авторизации


Value:

Must be String

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

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


Value:

Must be String

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

Код роли


Value:

Must be String

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

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


Value:

Must be String

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

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


Value:

Must be String

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

разместить результат на нескольких страницах


Value:

Must be String

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

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


Value:

Must be String


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

Параметры

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

Value:

Must be String


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

Adds role 'Anonymous' to the user by default

Параметры

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

Value:

Must be a Hash

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

Value:

Must be String

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

Value:

Must be String

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

Value:

Must be String

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

Value:

Must be String

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

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


Value:

Must be 'true' or 'false'

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

Value:

Must be String

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

Value:

Must be Integer

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

Временная зона пользователя


Value:

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

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

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


Value:

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


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

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

Параметры

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

Value:

Must be String

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

Value:

Must be a Hash

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

Value:

Must be String

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

Value:

Must be String

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

Value:

Must be String

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

Value:

Must be String

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

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


Value:

Must be 'true' or 'false'

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

Value:

Must be String

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

Value:

Must be Integer

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

Временная зона пользователя


Value:

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

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

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


Value:

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


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

Параметры

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

Value:

Must be String