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