Users

>>>

GET /api/users
List all users.

Parameter

Parametername Beschreibung
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
Show an user.

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String
>>>

POST /api/users
Create an user.

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

Validations:

  • Must be a String
user[lastname]
optional

Validations:

  • Must be a String
user[mail]
verpflichtend

Validations:

  • Must be a String
user[admin]
optional

Is an admin account?

Validations:

  • Must be one of: true, false, 1, 0
user[password]
verpflichtend

Validations:

  • Must be a String
user[auth_source_id]
verpflichtend

Validations:

  • Must be a Integer
>>>

PUT /api/users/:id
Update an user.

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

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[admin]
optional

Is an admin account?

Validations:

  • Must be one of: true, false, 1, 0
user[password]
optional

Validations:

  • Must be a String
>>>

DELETE /api/users/:id
Delete an user.

Parameter

Parametername Beschreibung
id
verpflichtend

Validations:

  • Must be a String