GET /api/users
List all users.

Params

Param Name Description
search
Optional

filtrer les résultats

Validations:

  • Must be String

order
Optional

trier les resultats

Validations:

  • Must be String

page
Optional

paginer les résultats

Validations:

  • Must be String

per_page
Optional

nombre d’entier par requête

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

Validations:

  • Must be String


POST /api/users
Create an user.

Adds role 'Anonymous' to the user by default

Params

Param Name Description
user
Required

Validations:

  • Must be a Hash

user[login]
Required

Validations:

  • Must be String

user[firstname]
Optional

Validations:

  • Must be String

user[lastname]
Optional

Validations:

  • Must be String

user[mail]
Required

Validations:

  • Must be String

user[admin]
Optional

Is an admin account?

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

user[password]
Required

Validations:

  • Must be String

user[auth_source_id]
Required

Validations:

  • Must be Integer


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

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

Params

Param Name Description
id
Required

Validations:

  • Must be String

user
Required

Validations:

  • Must be a Hash

user[login]
Optional

Validations:

  • Must be String

user[firstname]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

user[mail]
Optional

Validations:

  • Must be String

user[admin]
Optional

Is an admin account?

Validations:

  • Must be ‘true’ or ‘false’ or ‘1’ or ‘0’

user[password]
Optional

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

Validations:

  • Must be String