v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-10-2916802.4 MB
🔐 Authentication

Register user

The API endpoint allows users to register or signup to create their accounts.

post/users/register

Request body

emailstring
passwordstring
rolestring
usernamestring

Example request

{
  "email": "user.email@domain.com",
  "password": "test@123",
  "role": "ADMIN",
  "username": "doejohn"
}

Response

Register user

messagestring
statusCodenumber
successboolean

Example response

{
  "data": {
    "user": {
      "_id": "649e795264e7dba29b726936",
      "avatar": {
        "_id": "649e795264e7dba29b726935",
        "url": "https://via.placeholder.com/200x200.png"
      },
      "createdAt": "2023-06-30T06:42:26.163Z",
      "email": "user.email@domain.com",
      "loginType": "EMAIL_PASSWORD",
      "role": "ADMIN",
      "updatedAt": "2023-06-30T06:42:26.247Z",
      "username": "doejohn"
    }
  },
  "message": "Users registered successfully and verification email has been sent on your email.",
  "statusCode": 200,
  "success": true
}