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

Validations:

  • Must be String

usergroup_id
Optional

ユーザーグループの ID

Validations:

  • Must be String

role_id
Optional

ロールの ID

Validations:

  • Must be String

location_id
Optional

ロケーション別のスコープ

Validations:

  • Must be Integer

organization_id
Optional

組織別のスコープ

Validations:

  • Must be Integer

search
Optional

結果のフィルター

Validations:

  • Must be String

order
Optional

結果のソート

Validations:

  • Must be String

page
Optional

結果のページネーション

Validations:

  • Must be String

per_page
Optional

要求ごとのエントリー数

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

Validations:

  • Must be String


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

Adds role 'Default role' to the user by default

Params

Param Name Description
user
Required

Validations:

  • Must be a Hash

user[login]
Required

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be String

user[mail]
Required

Validations:

  • Must be String

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

管理者アカウントです

Validations:

  • Must be 'true' or 'false' or '1' or '0'

user[password]
Required

Validations:

  • Must be String

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

Validations:

  • Must be Integer

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

Validations:

  • Must be Integer

user[auth_source_id]
Required

Validations:

  • Must be Integer

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

ユーザーのタイムゾーン

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, Caracas, Atlantic Time (Canada), 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, Athens, Bucharest, Cairo, Harare, Helsinki, Istanbul, Jerusalem, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Kaliningrad, Kuwait, Minsk, Nairobi, Riyadh, Tehran, Abu Dhabi, Baku, Moscow, Muscat, Samara, St. Petersburg, Tbilisi, Volgograd, Yerevan, Kabul, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Ekaterinburg, Rangoon, Bangkok, Hanoi, Jakarta, Novosibirsk, Beijing, Chongqing, Hong Kong, Krasnoyarsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Urumqi, Irkutsk, Osaka, Sapporo, Seoul, Tokyo, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Yakutsk, New Caledonia, Solomon Is., Vladivostok, Auckland, Fiji, Kamchatka, Magadan, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..

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

ユーザーの優先ロケール

Validations:

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

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

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

Validations:

  • Must be an array of any type

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

組織を指定された 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.

Params

Param Name Description
id
Required

Validations:

  • Must be String

user
Required

Validations:

  • Must be a Hash

user[login]
Optional

Validations:

  • Must be String

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

Validations:

  • Must be String

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

Validations:

  • Must be String

user[mail]
Optional

Validations:

  • Must be String

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

管理者アカウントです

Validations:

  • Must be 'true' or 'false' or '1' or '0'

user[password]
Optional

Validations:

  • Must be String

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

Validations:

  • Must be Integer

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

Validations:

  • Must be Integer

user[auth_source_id]
Optional

Validations:

  • Must be Integer

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

ユーザーのタイムゾーン

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, Caracas, Atlantic Time (Canada), 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, Athens, Bucharest, Cairo, Harare, Helsinki, Istanbul, Jerusalem, Kyiv, Pretoria, Riga, Sofia, Tallinn, Vilnius, Baghdad, Kaliningrad, Kuwait, Minsk, Nairobi, Riyadh, Tehran, Abu Dhabi, Baku, Moscow, Muscat, Samara, St. Petersburg, Tbilisi, Volgograd, Yerevan, Kabul, Islamabad, Karachi, Tashkent, Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura, Kathmandu, Almaty, Astana, Dhaka, Ekaterinburg, Rangoon, Bangkok, Hanoi, Jakarta, Novosibirsk, Beijing, Chongqing, Hong Kong, Krasnoyarsk, Kuala Lumpur, Perth, Singapore, Taipei, Ulaanbaatar, Urumqi, Irkutsk, Osaka, Sapporo, Seoul, Tokyo, Adelaide, Darwin, Brisbane, Canberra, Guam, Hobart, Melbourne, Port Moresby, Sydney, Yakutsk, New Caledonia, Solomon Is., Vladivostok, Auckland, Fiji, Kamchatka, Magadan, Marshall Is., Wellington, Chatham Is., Nuku'alofa, Samoa, Tokelau Is..

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

ユーザーの優先ロケール

Validations:

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

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

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

Validations:

  • Must be an array of any type

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

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

Validations:

  • Must be an array of any type


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

Params

Param Name Description
id
Required

Validations:

  • Must be String