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 a String

usergroup_id
optional

사용자 그룹 ID

Validations:

  • Must be a String

role_id
optional

역할 ID

Validations:

  • Must be a String

location_id
optional

위치 별 범위

Validations:

  • Must be a Integer

organization_id
optional

조직 별 범위

Validations:

  • Must be a Integer

search
optional

필터 결과

Validations:

  • Must be a String

order
optional

결과 정렬

Validations:

  • Must be a String

page
optional

페이지네이션 결과

Validations:

  • Must be a String

per_page
optional

요청 당 항목 수

Validations:

  • Must be a String


GET /api/users/:id
사용자 표시

Params

Param name Description
id
required

Validations:

  • Must be a 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 a String

user[firstname]
optional , nil allowed

Validations:

  • Must be a String

user[lastname]
optional , nil allowed

Validations:

  • Must be a String

user[mail]
required

Validations:

  • Must be a String

user[description]
optional , nil allowed

Validations:

  • Must be a String

user[admin]
optional , nil allowed

관리자 계정입니다

Validations:

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

user[password]
required

Validations:

  • Must be a String

user[default_location_id]
optional , nil allowed

Validations:

  • Must be a Integer

user[default_organization_id]
optional , nil allowed

Validations:

  • Must be a Integer

user[auth_source_id]
required

Validations:

  • Must be a Integer

user[timezone]
optional , nil allowed

사용자의 시간대

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]
optional , nil allowed

사용자의 기본 로케일

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]
optional , nil allowed

Validations:

  • Must be an array of any type

user[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

user[organization_ids]
optional , nil allowed

지정된 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 a String

user
required

Validations:

  • Must be a Hash

user[login]
optional

Validations:

  • Must be a String

user[firstname]
optional , nil allowed

Validations:

  • Must be a String

user[lastname]
optional , nil allowed

Validations:

  • Must be a String

user[mail]
optional

Validations:

  • Must be a String

user[description]
optional , nil allowed

Validations:

  • Must be a String

user[admin]
optional , nil allowed

관리자 계정입니다

Validations:

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

user[password]
optional

Validations:

  • Must be a String

user[default_location_id]
optional , nil allowed

Validations:

  • Must be a Integer

user[default_organization_id]
optional , nil allowed

Validations:

  • Must be a Integer

user[auth_source_id]
optional

Validations:

  • Must be a Integer

user[timezone]
optional , nil allowed

사용자의 시간대

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]
optional , nil allowed

사용자의 기본 로케일

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]
optional , nil allowed

Validations:

  • Must be an array of any type

user[location_ids]
optional , nil allowed

지정된 ID로 위치를 변경합니다

Validations:

  • Must be an array of any type

user[organization_ids]
optional , nil allowed

지정된 ID로 조직을 변경합니다

Validations:

  • Must be an array of any type

user[current_password]
optional , nil allowed

Required when user want to change own password

Validations:

  • Must be a String


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

Params

Param name Description
id
required

Validations:

  • Must be a String