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 String

usergroup_id
选填

用户组 ID

Validations:

  • Must be String

role_id
选填

角色 ID

Validations:

  • Must be String

search
选填

过滤结果

Validations:

  • Must be String

order
选填

结果排序

Validations:

  • Must be String

page
选填

页数

Validations:

  • Must be String

per_page
选填

每个请求中的条目数

Validations:

  • Must be String


GET /api/users/:id
显示用户

参数

参数名字 描述
id
必填

Validations:

  • Must be String


POST /api/users
生成用户

Adds role 'Anonymous' to the user by default

参数

参数名字 描述
user
必填

Validations:

  • Must be a Hash

user[login]
必填

Validations:

  • Must be String

user[firstname]
选填 , 允许空值

Validations:

  • Must be String

user[lastname]
选填 , 允许空值

Validations:

  • Must be String

user[mail]
必填

Validations:

  • Must be String

user[admin]
选填 , 允许空值

是管理帐户

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

user[password]
必填

Validations:

  • Must be String

user[auth_source_id]
必填

Validations:

  • Must be Integer

user[timezone]
选填 , 允许空值

User's timezone

Validations:

  • 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, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, 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]
选填 , 允许空值

User's preferred locale

Validations:

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


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
必填

Validations:

  • Must be String

user
必填

Validations:

  • Must be a Hash

user[login]
选填

Validations:

  • Must be String

user[firstname]
选填 , 允许空值

Validations:

  • Must be String

user[lastname]
选填 , 允许空值

Validations:

  • Must be String

user[mail]
选填

Validations:

  • Must be String

user[admin]
选填 , 允许空值

是管理帐户

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

user[password]
选填

Validations:

  • Must be String

user[auth_source_id]
选填

Validations:

  • Must be Integer

user[timezone]
选填 , 允许空值

User's timezone

Validations:

  • 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, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, 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]
选填 , 允许空值

User's preferred locale

Validations:

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


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

参数

参数名字 描述
id
必填

Validations:

  • Must be String