API documentation

>>>

GET /api/users
List all users.

Params

Param name	Description
search optional	filter results Value: Must be String
order optional	sort results Value: Must be String
page optional	paginate results Value: Must be String
per_page optional	number of entries per request 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 , nil allowed	Value: Must be String
user[lastname] optional , nil allowed	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