Users

>>>

GET /api/users
Listar todos los usuarios

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

GET /api/auth_source_externals/:auth_source_external_id/users
List all users for external authentication source

GET /api/usergroups/:usergroup_id/users
Listar todos los usuarios por grupo de usuarios

GET /api/roles/:role_id/users
Listar todos los usuarios por rol

GET /api/locations/:location_id/users
Listar todos los usuarios por ubicación

GET /api/organizations/:organization_id/users
Listar todos los 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 a String
usergroup_id
opcional

ID del grupo de usuario

Validations:

  • Must be a String
role_id
opcional

ID del rol

Validations:

  • Must be a String
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer
organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer
search
opcional

filtrar resultados

Validations:

  • Must be a String
order
opcional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opcional

paginar resultados

Validations:

  • Must be a String
per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String

Campos de búsqueda

Nombre del campo Tipo Valores posibles
admin true, false
description text
firstname string
last_login_on datetime
lastname string
location string
location_id integer
login string
mail string
organization string
organization_id integer
role string
role_id integer
usergroup string
>>>

GET /api/users/:id
Mostrar un usuario

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer
organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer
id
requerido

Validations:

  • Must be a String
>>>

POST /api/users
Crear un usuario

Adds role 'Default role' to the user by default

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer
organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer
user
requerido

Validations:

  • Must be a Hash
user[login]
requerido

Validations:

  • Must be a String
user[firstname]
opcional , nil permitido

Validations:

  • Must be a String
user[lastname]
opcional , nil permitido

Validations:

  • Must be a String
user[mail]
requerido

Validations:

  • Must be a String
user[description]
opcional , nil permitido

Validations:

  • Must be a String
user[admin]
opcional , nil permitido

es una cuenta de administrador

Validations:

  • Must be one of: true, false, 1, 0.
user[password]
opcional , nil permitido

Required unless user is in an external authentication source

Validations:

  • Must be a String
user[default_location_id]
opcional , nil permitido

Validations:

  • Must be a Integer
user[default_organization_id]
opcional , nil permitido

Validations:

  • Must be a Integer
user[auth_source_id]
requerido

Validations:

  • Must be a Integer
user[timezone]
opcional , nil permitido

Zona horaria del usuario

Validations:

  • Must be one of: International Date Line West, American Samoa, 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, Puerto Rico, 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]
opcional , nil permitido

Idioma preferido del usuario

Validations:

  • Must be one of: en, sv_SE, es, ko, en_GB, de, zh_CN, pt_BR, ru, zh_TW, ja, gl, fr, ca, it, nl_NL, pl.
user[role_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type
user[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type
user[organization_ids]
opcional , nil permitido

REMPLAZAR 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
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer
organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer
id
requerido

Validations:

  • Must be a String
user
requerido

Validations:

  • Must be a Hash
user[login]
opcional

Validations:

  • Must be a String
user[firstname]
opcional , nil permitido

Validations:

  • Must be a String
user[lastname]
opcional , nil permitido

Validations:

  • Must be a String
user[mail]
opcional

Validations:

  • Must be a String
user[description]
opcional , nil permitido

Validations:

  • Must be a String
user[admin]
opcional , nil permitido

es una cuenta de administrador

Validations:

  • Must be one of: true, false, 1, 0.
user[password]
opcional , nil permitido

Required unless user is in an external authentication source

Validations:

  • Must be a String
user[default_location_id]
opcional , nil permitido

Validations:

  • Must be a Integer
user[default_organization_id]
opcional , nil permitido

Validations:

  • Must be a Integer
user[auth_source_id]
opcional

Validations:

  • Must be a Integer
user[timezone]
opcional , nil permitido

Zona horaria del usuario

Validations:

  • Must be one of: International Date Line West, American Samoa, 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, Puerto Rico, 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]
opcional , nil permitido

Idioma preferido del usuario

Validations:

  • Must be one of: en, sv_SE, es, ko, en_GB, de, zh_CN, pt_BR, ru, zh_TW, ja, gl, fr, ca, it, nl_NL, pl.
user[role_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type
user[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type
user[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type
user[current_password]
opcional , nil permitido

Requerido cuando el usuario quiere modificar su propia contraseña

Validations:

  • Must be a String
>>>

DELETE /api/users/:id
Borrar un usuario

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer
organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer
id
requerido

Validations:

  • Must be a String