GET /api/users
List all users.

Paramètres

Nom du paramètre Description
search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

trier les resultats

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entier par requête

Validations:

  • Must be a String


GET /api/users/:id
Show an user.

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String


POST /api/users
Create an user.

Adds role 'Default role' to the user by default

Paramètres

Nom du paramètre Description
user
requis

Validations:

  • Must be a Hash

user[login]
requis

Validations:

  • Must be a String

user[firstname]
optionel

Validations:

  • Must be a String

user[lastname]
optionel

Validations:

  • Must be a String

user[mail]
requis

Validations:

  • Must be a String

user[admin]
optionel

Is an admin account?

Validations:

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

user[password]
requis

Validations:

  • Must be a String

user[auth_source_id]
requis

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.

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String

user
requis

Validations:

  • Must be a Hash

user[login]
optionel

Validations:

  • Must be a String

user[firstname]
optionel , nil autorisé

Validations:

  • Must be a String

user[lastname]
optionel , nil autorisé

Validations:

  • Must be a String

user[mail]
optionel

Validations:

  • Must be a String

user[admin]
optionel

Is an admin account?

Validations:

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

user[password]
optionel

Validations:

  • Must be a String


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

Paramètres

Nom du paramètre Description
id
requis

Validations:

  • Must be a String