GET /api/users
List all users.

Params

Param Name Description
search
Optional

필터 결과

Validations:

  • Must be a String

order
Optional

결과 정렬

Validations:

  • Must be a String

page
Optional

페이지네이션 결과

Validations:

  • Must be a String

per_page
Optional

요청 당 항목 수

Validations:

  • Must be a String


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

Params

Param Name Description
id
Required

Validations:

  • Must be a String


POST /api/users
Create an user.

Adds role 'Default role' to the user by default

Params

Param Name Description
user
Required

Validations:

  • Must be a Hash

user[login]
Required

Validations:

  • Must be a String

user[firstname]
Optional

Validations:

  • Must be a String

user[lastname]
Optional

Validations:

  • Must be a String

user[mail]
Required

Validations:

  • Must be a String

user[admin]
Optional

Is an admin account?

Validations:

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

user[password]
Required

Validations:

  • Must be a String

user[auth_source_id]
Required

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.

Params

Param Name Description
id
Required

Validations:

  • Must be a String

user
Required

Validations:

  • Must be a Hash

user[login]
Optional

Validations:

  • Must be a String

user[firstname]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

user[lastname]
Optional , <span class="translation_missing" title="translation missing: ko.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be a String

user[mail]
Optional

Validations:

  • Must be a String

user[admin]
Optional

Is an admin account?

Validations:

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

user[password]
Optional

Validations:

  • Must be a String


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

Params

Param Name Description
id
Required

Validations:

  • Must be a String