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


Value:

Must be String

usergroup_id
opcional

ID del grupo de usuario


Value:

Must be String

role_id
opcional

ID del rol


Value:

Must be String

search
opcional

filtrar resultados


Value:

Must be String

order
opcional

ordenar resultados


Value:

Must be String

page
opcional

paginar resultados


Value:

Must be String

per_page
opcional

número de entradas por petición


Value:

Must be String


GET /api/users/:id
Mostrar un usuario

Parámetros

Nombre del parámetro Descripción
id
requerido

Value:

Must be String


POST /api/users
Crear un usuario

Adds role 'Anonymous' to the user by default

Parámetros

Nombre del parámetro Descripción
user
requerido

Value:

Must be a Hash

user[login]
requerido

Value:

Must be String

user[firstname]
opcional , nil permitido

Value:

Must be String

user[lastname]
opcional , nil permitido

Value:

Must be String

user[mail]
requerido

Value:

Must be String

user[admin]
opcional , nil permitido

es una cuenta de administrador


Value:

Must be 'true' or 'false'

user[password]
requerido

Value:

Must be String

user[auth_source_id]
requerido

Value:

Must be Integer

user[timezone]
opcional , nil permitido

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, 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]
opcional , nil permitido

Idioma preferido por el usuario


Value:

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


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.

Parámetros

Nombre del parámetro Descripción
id
requerido

Value:

Must be String

user
requerido

Value:

Must be a Hash

user[login]
opcional

Value:

Must be String

user[firstname]
opcional , nil permitido

Value:

Must be String

user[lastname]
opcional , nil permitido

Value:

Must be String

user[mail]
opcional

Value:

Must be String

user[admin]
opcional , nil permitido

es una cuenta de administrador


Value:

Must be 'true' or 'false'

user[password]
opcional

Value:

Must be String

user[auth_source_id]
opcional

Value:

Must be Integer

user[timezone]
opcional , nil permitido

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, 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]
opcional , nil permitido

Idioma preferido por el usuario


Value:

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


DELETE /api/users/:id
Borrar un usuario

Parámetros

Nombre del parámetro Descripción
id
requerido

Value:

Must be String