GET /api/users
Enumera todos los usuarios

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Enumerar los usuarios por fuente de autenticación LDAP

GET /api/usergroups/:usergroup_id/users
Enumerar Usuarios por grupo de usuarios

GET /api/roles/:role_id/users
Enumerar usuarios por rol

GET /api/locations/:location_id/users
Enumerar usuarios por ubicación

GET /api/organizations/:organization_id/users
Enumerar usuarios por organización

Params

Param Name Description
auth_source_ldap_id
Optional

ID de la fuente de identificación LDAP


Value: Must be String
usergroup_id
Optional

ID del grupo de usuario


Value: Must be String
role_id
Optional

ID del rol


Value: Must be String
search
Optional

filtrar resultados


Value: Must be String
order
Optional

ordenar resultados


Value: Must be String
page
Optional

paginar resultados


Value: Must be String
per_page
Optional

número de entradas por petición


Value: Must be String

GET /api/users/:id
Mostrar un usuario

Params

Param Name Description
id
Required

Value: Must be String

POST /api/users
Crear un usuario

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

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

es una cuenta de administrador


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

Zona horaria del usuario


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

Idioma preferido por el usuario


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

PUT /api/users/:id
Actualizar un usuario

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

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

es una cuenta de administrador


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

Zona horaria del usuario


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

Idioma preferido por el usuario


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

DELETE /api/users/:id
Borrar un usuario

Params

Param Name Description
id
Required

Value: Must be String