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


Value:

Must be String

usergroup_id
opcional

ID do grupo de usuários


Value:

Must be String

role_id
opcional

ID da função


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 requisições


Value:

Must be String


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

Parâmentros

Nome parâmetro Descrição
id
requerido

Value:

Must be String


POST /api/users
Criar um usuário

Adds role 'Anonymous' to the user by default

Parâmentros

Nome parâmetro Descrição
user
requerido

Value:

Must be a Hash

user[login]
requerido

Value:

Must be String

user[firstname]
opcional , nulo permitido

Value:

Must be String

user[lastname]
opcional , nulo permitido

Value:

Must be String

user[mail]
requerido

Value:

Must be String

user[admin]
opcional , nulo permitido

é uma conta administradora


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

User's timezone


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

User's preferred locale


Value:

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


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

Adds role 'Anonymous' 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

Value:

Must be String

user
requerido

Value:

Must be a Hash

user[login]
opcional

Value:

Must be String

user[firstname]
opcional , nulo permitido

Value:

Must be String

user[lastname]
opcional , nulo permitido

Value:

Must be String

user[mail]
opcional

Value:

Must be String

user[admin]
opcional , nulo permitido

é uma conta administradora


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

User's timezone


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

User's preferred locale


Value:

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


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

Parâmentros

Nome parâmetro Descrição
id
requerido

Value:

Must be String