Users

>>>

GET /api/users
列出所有使用者

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
列出 LDAP 認證來源的所有使用者

GET /api/auth_source_externals/:auth_source_external_id/users
List all users for external authentication source

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

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
選填

編頁結果

Validations:

  • Must be a String
per_page
選填

每個請求的項目數量

Validations:

  • Must be a String

Search fields

Field name 類型 Possible values
admin true, false
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string
>>>

GET /api/users/:id
顯示使用者

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer
organization_id
選填

組織範圍

Validations:

  • Must be a Integer
id
必填

Validations:

  • Must be a String
>>>

POST /api/users
建立使用者

Adds role 'Default role' to the user by default

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer
organization_id
選填

組織範圍

Validations:

  • Must be a Integer
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]
選填 , 允許空值

Required unless user is in an external authentication source

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: International Date Line West, American Samoa, 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, Puerto Rico, 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: en, sv_SE, es, ko, en_GB, de, zh_CN, pt_BR, ru, zh_TW, ja, gl, fr, ca, it, nl_NL, pl.
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.

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer
organization_id
選填

組織範圍

Validations:

  • Must be a Integer
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]
選填 , 允許空值

Required unless user is in an external authentication source

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: International Date Line West, American Samoa, 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, Puerto Rico, 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: en, sv_SE, es, ko, en_GB, de, zh_CN, pt_BR, ru, zh_TW, ja, gl, fr, ca, it, nl_NL, pl.
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
刪除使用者

參數

參數名字 描述
location_id
選填

位置範圍

Validations:

  • Must be a Integer
organization_id
選填

組織範圍

Validations:

  • Must be a Integer
id
必填

Validations:

  • Must be a String