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
組織のすべてのユーザーを一覧表示

Params

Param Name Description
auth_source_ldap_id
Optional

LDAP認証元の ID


Value:

Must be String

usergroup_id
Optional

ユーザーグループの ID


Value:

Must be String

role_id
Optional

ロールの ID


Value:

Must be String

search
Optional

結果をフィルタ


Value:

Must be String

order
Optional

結果をソート


Value:

Must be String

page
Optional

結果をページ分割


Value:

Must be String

per_page
Optional

リクエストあたりのエントリ数


Value:

Must be String


GET /api/users/:id
ユーザーの表示

Params

Param Name Description
id
Required

Value:

Must be String


POST /api/users
ユーザーの作成

Adds role 'Anonymous' to the user by default

Params

Param Name Description
user
Required

Value:

Must be a Hash

user[login]
Required

Value:

Must be String

user[firstname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

user[mail]
Required

Value:

Must be String

user[admin]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

管理者アカウントです


Value:

Must be 'true' or 'false'

user[password]
Required

Value:

Must be String

user[auth_source_id]
Required

Value:

Must be Integer

user[timezone]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ユーザーのタイムゾーン


Value:

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, Moscow, St. Petersburg, Volgograd, 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]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ユーザーの優先ロケール


Value:

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


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.

Params

Param Name Description
id
Required

Value:

Must be String

user
Required

Value:

Must be a Hash

user[login]
Optional

Value:

Must be String

user[firstname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

user[mail]
Optional

Value:

Must be String

user[admin]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

管理者アカウントです


Value:

Must be 'true' or 'false'

user[password]
Optional

Value:

Must be String

user[auth_source_id]
Optional

Value:

Must be Integer

user[timezone]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ユーザーのタイムゾーン


Value:

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, Moscow, St. Petersburg, Volgograd, 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]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

ユーザーの優先ロケール


Value:

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


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

Params

Param Name Description
id
Required

Value:

Must be String