Authenticator

API Documentation for the Authenticator app

Authorization

This authenticator app is role and permission-based. We must define an initial and default set of roles and permissions that our app must start with and also provide a way of assigning them to users.

Set of roles

Coming soon

Set of permissions

Coming soon

User registration

Description: This endpoint allows a user to register their account Path: /auth/register
Method: POST
Status: 201

Request body

{
  "names": "John Doe",
  "email": "john@doe.com",
  "username": "john-1153", //not required, if not provided: built with one name + 4 random numbers
  "password": "Abc123!@#" // Alpha-Numeric-Characters,
}

Response

{
  "message": {
    "names": "You have created your account successfully. Please, check your email to activate it"
  },
  "status": 201
}

User login

Description: This endpoint allows a user to login
Path: /auth/login
Method: POST
Status: 200

Request body

{
  "email": "john@doe.com",
  "password": "Abc123!@#" // Alpha-Numeric-Characters,
}

Response

{
  "message": {
    "names": "You have logged in successfully."
  },
  "user": {
    "names": "John Doe",
    "email": "john@doe.com",
    "profile": "",
    "username": "john2134",
    "bio": ""
  },
  "status": 200
}