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 'Anonymous' 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 'Anonymous' 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]
необязательно , nil разрешен

Validations:

  • Must be String
user[lastname]
необязательно , nil разрешен

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