GET /api/users
List all users.

Params

Param name Description
search
optional

filter results

Validations:

  • Must be String

order
optional

sort results

Validations:

  • Must be String

page
optional

paginate results

Validations:

  • Must be String

per_page
optional

number of entries per request

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 , nil allowed

Validations:

  • Must be String

user[lastname]
optional , nil allowed

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