POST /signup
Create a new user

POST /users
Create a new user

Supported Formats

html, json

Params

Param name Description
account_type
required

The signup role for the new user. Must be one of the roles defined in roles.yml. This determines the user's roles and consequently permissions.

Validations:

  • Must be String

user
required

Data used in creation of the user model.

Validations:

  • Must be a Hash

user[full_name]
required

The user's full name.

Validations:

  • Must be String

user[email]
required

The user's email address.

Validations:

  • Must match regular expression /\A[-a-z0-9_+\.]+\@([-a-z0-9]\.)[a-z0-9]{2,}\z/.

user[password]
required

The user's password.

Validations:

  • Must be String

user[password_confirmation]
required

The user's password confirmation. Must be the same as password.

Validations:

  • Must be String

user[user_liaison]
required

Validations:

  • Must be String


PATCH /users/:id
Update a user

PUT /users/:id
Update a user

Supported Formats

html, json

Params

Param name Description
id
required

Unique identifier for the user model that determines which user will be updated.

Validations:

  • Must be Integer

user
required

Data used in updating the user model.

Validations:

  • Must be a Hash

user[full_name]
optional

The user's full name.

Validations:

  • Must be String

user[email]
optional

The user's email address.

Validations:

  • Must match regular expression /\A[-a-z0-9_+\.]+\@([-a-z0-9]\.)[a-z0-9]{2,}\z/.

user[password]
optional

The user's password.

Validations:

  • Must be String

user[password_confirmation]
optional

The user's password confirmation. Must be the same as password.

Validations:

  • Must be String


GET /users
List of users

Supported Formats

json

Params

Param name Description
email
optional

(query parameter) Search for users that match the email specified.

Validations:

  • Must be String


GET /users/:id
Show a user. Admins can show any user, normal users can only get their own details.

Supported Formats

json

Params

Param name Description
id
optional

Unique identifier for the user model that determines which user will be shown.

Validations:

  • Must be Integer