Users

>>>

GET /api/users
List all users.

参数

参数名字 描述
search
选填

过滤结果

Validations:

  • Must be String
order
选填

结果排序

Validations:

  • Must be String
page
选填

页数

Validations:

  • Must be String
per_page
选填

每个请求中的条目数

Validations:

  • Must be String
>>>

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

参数

参数名字 描述
id
必填

Validations:

  • Must be String
>>>

POST /api/users
Create an user.

Adds role 'Default role' to the user by default

参数

参数名字 描述
user
必填

Validations:

  • Must be a Hash
user[login]
必填

Validations:

  • Must be String
user[firstname]
选填

Validations:

  • Must be String
user[lastname]
选填

Validations:

  • Must be String
user[mail]
必填

Validations:

  • Must be String
user[admin]
选填

Is an admin account?

Validations:

  • Must be 'true' or 'false' or '1' or '0'
user[password]
必填

Validations:

  • Must be String
user[auth_source_id]
必填

Validations:

  • Must be 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.

参数

参数名字 描述
id
必填

Validations:

  • Must be String
user
必填

Validations:

  • Must be a Hash
user[login]
选填

Validations:

  • Must be String
user[firstname]
选填 , 允许空值

Validations:

  • Must be String
user[lastname]
选填 , 允许空值

Validations:

  • Must be String
user[mail]
选填

Validations:

  • Must be String
user[admin]
选填

Is an admin account?

Validations:

  • Must be 'true' or 'false' or '1' or '0'
user[password]
选填

Validations:

  • Must be String
>>>

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

参数

参数名字 描述
id
必填

Validations:

  • Must be String