GET /api/users
Alle Benutzer auflisten

GET /api/auth_source_ldaps/:auth_source_ldap_id/users
Aller Benutzer für die LDAP-Authentifizierungsquelle auflisten

GET /api/usergroups/:usergroup_id/users
Alle Benutzer für die Benutzergruppe auflisten

GET /api/roles/:role_id/users
Alle Benutzer für die Rolle auflisten

GET /api/locations/:location_id/users
Alle Benutzer für den Standort auflisten

GET /api/organizations/:organization_id/users
Alle Benutzer für die Organisation auflisten

Parameter

Parametername Beschreibung
auth_source_ldap_id
optional

Kennung der Authentifizierungsquelle

Validations:

  • Must be a String

usergroup_id
optional

Kennung der Benutzergruppe

Validations:

  • Must be a String

role_id
optional

Kennung der Rolle

Validations:

  • Must be a String

location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/users/:id
Benutzer anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String


POST /api/users
Einen Benutzer erstellen

Adds role 'Default role' to the user by default

Parameter

Parametername Beschreibung
user
verpflichtend

Validations:

  • Must be a Hash

user[login]
verpflichtend

Validations:

  • Must be a String

user[firstname]
optional , nil erlaubt

Validations:

  • Must be a String

user[lastname]
optional , nil erlaubt

Validations:

  • Must be a String

user[mail]
verpflichtend

Validations:

  • Must be a String

user[description]
optional , nil erlaubt

Validations:

  • Must be a String

user[admin]
optional , nil erlaubt

ist ein Administrator-Account

Validations:

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

user[password]
verpflichtend

Validations:

  • Must be a String

user[default_location_id]
optional , nil erlaubt

Validations:

  • Must be a Integer

user[default_organization_id]
optional , nil erlaubt

Validations:

  • Must be a Integer

user[auth_source_id]
verpflichtend

Validations:

  • Must be a Integer

user[timezone]
optional , nil erlaubt

Zeitzone des Benutzers

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]
optional , nil erlaubt

Bevorzugte Regionseinstellung des Benutzers

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]
optional , nil erlaubt

Validations:

  • Must be an array of any type

user[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

user[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/users/:id
Benutzer aktualisieren

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

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String

user
verpflichtend

Validations:

  • Must be a Hash

user[login]
optional

Validations:

  • Must be a String

user[firstname]
optional , nil erlaubt

Validations:

  • Must be a String

user[lastname]
optional , nil erlaubt

Validations:

  • Must be a String

user[mail]
optional

Validations:

  • Must be a String

user[description]
optional , nil erlaubt

Validations:

  • Must be a String

user[admin]
optional , nil erlaubt

ist ein Administrator-Account

Validations:

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

user[password]
optional

Validations:

  • Must be a String

user[default_location_id]
optional , nil erlaubt

Validations:

  • Must be a Integer

user[default_organization_id]
optional , nil erlaubt

Validations:

  • Must be a Integer

user[auth_source_id]
optional

Validations:

  • Must be a Integer

user[timezone]
optional , nil erlaubt

Zeitzone des Benutzers

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]
optional , nil erlaubt

Bevorzugte Regionseinstellung des Benutzers

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]
optional , nil erlaubt

Validations:

  • Must be an array of any type

user[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

user[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

user[current_password]
optional , nil erlaubt

Required when user want to change own password

Validations:

  • Must be a String


DELETE /api/users/:id
Benutzer löschen

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String