GET /api/users
Listar todos os usuários

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Listar todos os usuários da origem de autenticação LDAP

GET /api/usergroups/:usergroup_id/users
Listar todos os usuários para grupo de usuário

GET /api/roles/:role_id/users
Listar todos os usuários para a função

GET /api/locations/:location_id/users
Listar todos os usuários para local

GET /api/organizations/:organization_id/users
Listar todos os usuários para organização

Parâmentros

Nome parâmetro Descrição
auth_source_ldap_id
opcional

ID da fonte de autenticação do LDAP

Validations:

  • Must be a String

usergroup_id
opcional

ID do grupo de usuários

Validations:

  • Must be a String

role_id
opcional

ID da função

Validations:

  • Must be a String

location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /api/users/:id
Mostrar um usuário

Parâmentros

Nome parâmetro Descrição
id
requerido

Validations:

  • Must be a String


POST /api/users
Criar um usuário

Adds role 'Default role' to the user by default

Parâmentros

Nome parâmetro Descrição
user
requerido

Validations:

  • Must be a Hash

user[login]
requerido

Validations:

  • Must be a String

user[firstname]
opcional , nulo permitido

Validations:

  • Must be a String

user[lastname]
opcional , nulo permitido

Validations:

  • Must be a String

user[mail]
requerido

Validations:

  • Must be a String

user[description]
opcional , nulo permitido

Validations:

  • Must be a String

user[admin]
opcional , nulo permitido

é uma conta administradora

Validations:

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

user[password]
requerido

Validations:

  • Must be a String

user[default_location_id]
opcional , nulo permitido

Validations:

  • Must be a Integer

user[default_organization_id]
opcional , nulo permitido

Validations:

  • Must be a Integer

user[auth_source_id]
requerido

Validations:

  • Must be a Integer

user[timezone]
opcional , nulo permitido

Fuso horário do usuário

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

Localidade preferencial do usuário

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

Validations:

  • Must be an array of any type

user[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

user[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/users/:id
Atualizar um Usuário

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

Parâmentros

Nome parâmetro Descrição
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 , nulo permitido

Validations:

  • Must be a String

user[lastname]
opcional , nulo permitido

Validations:

  • Must be a String

user[mail]
opcional

Validations:

  • Must be a String

user[description]
opcional , nulo permitido

Validations:

  • Must be a String

user[admin]
opcional , nulo permitido

é uma conta administradora

Validations:

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

user[password]
opcional

Validations:

  • Must be a String

user[default_location_id]
opcional , nulo permitido

Validations:

  • Must be a Integer

user[default_organization_id]
opcional , nulo permitido

Validations:

  • Must be a Integer

user[auth_source_id]
opcional

Validations:

  • Must be a Integer

user[timezone]
opcional , nulo permitido

Fuso horário do usuário

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

Localidade preferencial do usuário

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

Validations:

  • Must be an array of any type

user[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

user[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type

user[current_password]
opcional , nulo permitido

Required when user want to change own password

Validations:

  • Must be a String


DELETE /api/users/:id
Apagar um usuário

Parâmentros

Nome parâmetro Descrição
id
requerido

Validations:

  • Must be a String