GET /api/users
List all users.

パラメーター

パラメーター名 記述
search
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

結果のソート

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


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

パラメーター

パラメーター名 記述
id
必須

Validations:

  • Must be a 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 a String

user[firstname]
任意

Validations:

  • Must be a String

user[lastname]
任意

Validations:

  • Must be a String

user[mail]
必須

Validations:

  • Must be a String

user[admin]
任意

Is an admin account?

Validations:

  • Must be one of: true, false, 1, 0

user[password]
必須

Validations:

  • Must be a String

user[auth_source_id]
必須

Validations:

  • Must be a 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 a String

user
必須

Validations:

  • Must be a Hash

user[login]
任意

Validations:

  • Must be a String

user[firstname]
任意 , nil可

Validations:

  • Must be a String

user[lastname]
任意 , nil可

Validations:

  • Must be a String

user[mail]
任意

Validations:

  • Must be a String

user[admin]
任意

Is an admin account?

Validations:

  • Must be one of: true, false, 1, 0

user[password]
任意

Validations:

  • Must be a String


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

パラメーター

パラメーター名 記述
id
必須

Validations:

  • Must be a String