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]
任意 , nil可

Validations:

  • Must be a String

user[lastname]
任意 , nil可

Validations:

  • Must be a String

user[mail]
必須

Validations:

  • Must be a String

user[description]
任意 , nil可

Validations:

  • Must be a String

user[admin]
任意 , nil可

管理者アカウントです

Validations:

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

user[password]
必須

Validations:

  • Must be a String

user[default_location_id]
任意 , nil可

Validations:

  • Must be a Integer

user[default_organization_id]
任意 , nil可

Validations:

  • Must be a Integer

user[auth_source_id]
必須

Validations:

  • Must be a Integer

user[timezone]
任意 , nil可

ユーザーのタイムゾーン

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]
任意 , nil可

ユーザーの優先ロケール

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]
任意 , nil可

Validations:

  • Must be an array of any type

user[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

user[organization_ids]
任意 , nil可

組織を指定された 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]
任意 , nil可

Validations:

  • Must be a String

user[lastname]
任意 , nil可

Validations:

  • Must be a String

user[mail]
任意

Validations:

  • Must be a String

user[description]
任意 , nil可

Validations:

  • Must be a String

user[admin]
任意 , nil可

管理者アカウントです

Validations:

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

user[password]
任意

Validations:

  • Must be a String

user[default_location_id]
任意 , nil可

Validations:

  • Must be a Integer

user[default_organization_id]
任意 , nil可

Validations:

  • Must be a Integer

user[auth_source_id]
任意

Validations:

  • Must be a Integer

user[timezone]
任意 , nil可

ユーザーのタイムゾーン

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]
任意 , nil可

ユーザーの優先ロケール

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]
任意 , nil可

Validations:

  • Must be an array of any type

user[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

user[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type

user[current_password]
任意 , nil可

ユーザーが独自のパスワードを変更する場合に必須

Validations:

  • Must be a String


DELETE /api/users/:id
ユーザーの削除

パラメーター

パラメーター名 記述
id
必須

Validations:

  • Must be a String