Signup

POST /users: Signs up the user provided a unique username, email and password

{
    "username": string,
    "password": string,
    "email": string
}

Example Request

Body

{
  "email": "john@example.com",
  "password": "12345"
}

Parameters

---

name (Required, Unique)

Usernames must start with a letter and can only contain the following characters: a-zA-Z0-9_ and must be 50 characters or less

Note: If the username is valid, it will be lowercased

Min: 2 characters
Max: 15 characters

---

email (Required, Unique)

Emails must be valid (i.e. Must include @ and a valid TLD)

---

password (Required)

Min: 3 characters
Max: 45 characters (See note below)

Note: Since bcrypt is used to hash the passwords, there is a 50 character string length limitation.

---

Possible Responses

Immediate Success

{
  "_id": "6233edc698a43c3db89c4936",
  "email": "john@example.com"
}

Failure

{
  "message": "User already exists",
  "stack": "Error: User already exists"
}

{
  "message": "User validation failed: email: Path `email` is required.",
  "stack": "ValidationError: User validation failed: email: Path `email` is required.\n"
}