GET /api/users
List all users.

Params

Param Name Description
search
Optional

filtrer les résultats


Value: Must be String
order
Optional

trier les resultats


Value: Must be String
page
Optional

paginer les resultats


Value: Must be String
per_page
Optional

nombre d’entier par requête


Value: Must be String

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

Params

Param Name Description
id
Required

Value: Must be String

POST /api/users
Create an user.

Adds role 'Anonymous' to the user by default

Params

Param Name Description
user
Required

Value: Must be a Hash
user[login]
Required

Value: Must be String
user[firstname]
Optional

Value: Must be String
user[lastname]
Optional

Value: Must be String
user[mail]
Required

Value: Must be String
user[admin]
Optional

Is an admin account?


Value: Must be 'true' or 'false'
user[password]
Required

Value: Must be String
user[auth_source_id]
Required

Value: 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

Value: Must be String
user
Required

Value: Must be a Hash
user[login]
Optional

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

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

Value: Must be String
user[mail]
Optional

Value: Must be String
user[admin]
Optional

Is an admin account?


Value: Must be 'true' or 'false'
user[password]
Optional

Value: Must be String

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

Params

Param Name Description
id
Required

Value: Must be String