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

Parámetros

Nombre del parámetro Descripción
auth_source_ldap_id
opcional

ID de la fuente de identificación LDAP

Validations:

  • Must be String

usergroup_id
opcional

ID del grupo de usuario

Validations:

  • Must be String

role_id
opcional

ID del rol

Validations:

  • Must be String

location_id
opcional

Ámbito por ubicación

Validations:

  • Must be Integer

organization_id
opcional

Ámbito por organización

Validations:

  • Must be Integer

search
opcional

filtrar resultados

Validations:

  • Must be String

order
opcional

ordenar resultados

Validations:

  • Must be String

page
opcional

paginar resultados

Validations:

  • Must be String

per_page
opcional

número de entradas por petición

Validations:

  • Must be String


GET /api/users/:id
Mostrar un usuario

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be String


POST /api/users
Crear un usuario

Adds role 'Default role' to the user by default

Parámetros

Nombre del parámetro Descripción
user
requerido

Validations:

  • Must be a Hash

user[login]
requerido

Validations:

  • Must be String

user[firstname]
opcional , nil permitido

Validations:

  • Must be String

user[lastname]
opcional , nil permitido

Validations:

  • Must be String

user[mail]
requerido

Validations:

  • Must be String

user[admin]
opcional , nil permitido

es una cuenta de administrador

Validations:

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

user[password]
requerido

Validations:

  • Must be String

user[default_location_id]
opcional , nil permitido

Validations:

  • Must be Integer

user[default_organization_id]
opcional , nil permitido

Validations:

  • Must be Integer

user[auth_source_id]
requerido

Validations:

  • Must be Integer

user[timezone]
opcional , nil permitido

Zona horaria del usuario

Validations:

  • 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, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, 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]
opcional , nil permitido

Idioma preferido por el usuario

Validations:

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

user[location_ids]
opcional , nil permitido

REEMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

user[organization_ids]
opcional , nil permitido

REEMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/users/:id
Actualizar un usuario

Adds role 'Default role' to the user if it is not already present. Only another admin can change the admin account attribute.

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be String

user
requerido

Validations:

  • Must be a Hash

user[login]
opcional

Validations:

  • Must be String

user[firstname]
opcional , nil permitido

Validations:

  • Must be String

user[lastname]
opcional , nil permitido

Validations:

  • Must be String

user[mail]
opcional

Validations:

  • Must be String

user[admin]
opcional , nil permitido

es una cuenta de administrador

Validations:

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

user[password]
opcional

Validations:

  • Must be String

user[default_location_id]
opcional , nil permitido

Validations:

  • Must be Integer

user[default_organization_id]
opcional , nil permitido

Validations:

  • Must be Integer

user[auth_source_id]
opcional

Validations:

  • Must be Integer

user[timezone]
opcional , nil permitido

Zona horaria del usuario

Validations:

  • 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, Kaliningrad, Moscow, St. Petersburg, Volgograd, Samara, 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]
opcional , nil permitido

Idioma preferido por el usuario

Validations:

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

user[location_ids]
opcional , nil permitido

REEMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

user[organization_ids]
opcional , nil permitido

REEMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


DELETE /api/users/:id
Borrar un usuario

Parámetros

Nombre del parámetro Descripción
id
requerido

Validations:

  • Must be String