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: ko.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: ko.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: ko.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: ko.apipie.nil_allowed">Nil Allowed</span>

User's timezone


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: ko.apipie.nil_allowed">Nil Allowed</span>

User's preferred locale


Value:

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


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: ko.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: ko.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: ko.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: ko.apipie.nil_allowed">Nil Allowed</span>

User's timezone


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: ko.apipie.nil_allowed">Nil Allowed</span>

User's preferred locale


Value:

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


DELETE /api/users/:id
사용자 삭제

Params

Param Name Description
id
Required

Value:

Must be String