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 认证源的 ID

Validations:

  • Must be a String

usergroup_id
选填

用户组 ID

Validations:

  • Must be a String

role_id
选填

角色 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]
选填 , 允许空值

Validations:

  • Must be a String

user[lastname]
选填 , 允许空值

Validations:

  • Must be a String

user[mail]
必填

Validations:

  • Must be a String

user[description]
选填 , 允许空值

Validations:

  • Must be a String

user[admin]
选填 , 允许空值

是管理员帐户

Validations:

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

user[password]
必填

Validations:

  • Must be a String

user[default_location_id]
选填 , 允许空值

Validations:

  • Must be a Integer

user[default_organization_id]
选填 , 允许空值

Validations:

  • Must be a Integer

user[auth_source_id]
必填

Validations:

  • Must be a Integer

user[timezone]
选填 , 允许空值

用户的时区

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]
选填 , 允许空值

用户的首选区域设置

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]
选填 , 允许空值

Validations:

  • Must be an array of any type

user[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

user[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

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]
选填 , 允许空值

Validations:

  • Must be a String

user[lastname]
选填 , 允许空值

Validations:

  • Must be a String

user[mail]
选填

Validations:

  • Must be a String

user[description]
选填 , 允许空值

Validations:

  • Must be a String

user[admin]
选填 , 允许空值

是管理员帐户

Validations:

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

user[password]
选填

Validations:

  • Must be a String

user[default_location_id]
选填 , 允许空值

Validations:

  • Must be a Integer

user[default_organization_id]
选填 , 允许空值

Validations:

  • Must be a Integer

user[auth_source_id]
选填

Validations:

  • Must be a Integer

user[timezone]
选填 , 允许空值

用户的时区

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]
选填 , 允许空值

用户的首选区域设置

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]
选填 , 允许空值

Validations:

  • Must be an array of any type

user[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

user[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type

user[current_password]
选填 , 允许空值

Required when user want to change own password

Validations:

  • Must be a String


DELETE /api/users/:id
删除用户

参数

参数名字 描述
id
必填

Validations:

  • Must be a String