Skip to content

Latest commit

 

History

History
343 lines (265 loc) · 4.9 KB

auth.md

File metadata and controls

343 lines (265 loc) · 4.9 KB

User API Documentation

Table of Content

Base URL

<base-url>/user

Endpoints

GET /home

Description

Returns a welcome message from the BioEntrust Auth server.

Request

  • Method: GET
  • URL: user/home

Response

  • 200 OK

    {
    "new_data": "Welcome to BioEntrust Auth server"
}

  • 500 Internal Server Error

    {
    "status": "error",
    "message": "Error message"
}

GET /protected

Description

Returns a protected message from the BioEntrust Auth server. Requires JWT authentication.

Request

  • Method: GET
  • URL: user/protected

Response

  • 200 OK

    {
    "new_data": "Protected data"
}

  • 401 Unauthorized

    {
    "status": "error",
    "message": "Unauthorized"
}

  • 500 Internal Server Error

    {
    "status": "error",
    "message": "Error message"
}

POST /signup

Description

Registers a new user and sends an OTP to the provided email for verification.

Request

  • Method: POST

  • URL: /user/signup

  • Body: JSON

    {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "password": "password123"
}

Response

  • 200 OK

    {
    "otp_request_id": "some_unique_id",
    "response": "otp sent"
}

  • 400 Bad Request

    {
    "error": "Password should be more than 7 characters"
}

  • 409 Conflict

    {
    "error": "Email address already in use"
}

POST /verify_email

Description

Verifies the user's email by checking the provided OTP.

Request

  • Method: POST

  • URL: /user/verify-email

  • Body: JSON

    {
    "otp": "123456",
    "otp_request_id": "some_unique_id"
}

Response

  • 200 OK

    {
    "message": "Logged In",
    "token": {
        "access": "access_token",
        "refresh": "refresh_token"
    }
}

  • 401 Unauthorized

    {
    "error": "Signup Failed"
}

POST /signin

Description

Authenticates a user and returns an access token and a refresh token.

Request

  • Method: POST

  • URL: /user/signin

  • Body: JSON

    {
    "email": "[email protected]",
    "password": "password123"
}

Response

  • 200 OK

    {
    "message": "Logged In",
    "token": {
        "access": "access_token",
        "refresh": "refresh_token"
    }
}

  • 401 Unauthorized

    {
    "error": "Invalid login credentials"
}

POST /verify_sms

Description

Verifies the user's phone number by checking the provided SMS OTP.

Request

  • Method: POST

  • URL: /user/verify-sms

  • Body: JSON

    {
    "app_id": 09876,
    "otp": "123456",
    "otp_request_id": "some_unique_id"
}

Response

  • 200 OK

    {
    "message": "Phone number verified"
}

  • 401 Unauthorized

    {
    "error": "Verification failed"
}

DELETE /signout

Description

Signs out the user by revoking the access and refresh tokens.

Request

  • Method: DELETE
  • URL: /user/signout
  • Required Bearer Authentication (refresh-token)

Response

  • 200 OK

    {
    "message": "Signed out successfully"
}

GET /refresh

Description

Refreshes the access token using the refresh token.

Request

  • Method: GET
  • URL: /user/refresh
  • Requires Bearer Authentication (refresh-token)

Response

  • 200 OK

    {
  "token":
  {
    "access": "yada-yada-yada-yada-yada-yada-yada-yada-yada-yada-"
  }
}

POST /forgot-password

Description

Sends a password reset link to the user's email.

Request

  • Method: POST

  • URL: /user/forgot-password

  • Body: JSON

    {
    "email": "[email protected]",
    "password": "1234567890"
}

Response

  • 200 OK

    {
    "message": "Password reset link sent"
}

POST /reset-password

Description

Resets the user's password using the provided token.

Request

  • Method: POST

  • URL: /auth/reset-password

  • Body: JSON

  • Requires Bearer Authentication (access-token)

    {
    "email": "[email protected]",
    "password": "newpassword123"
}

Response

  • 200 OK

    {
    "message": "Password reset successfully"
}

  • 400 Bad Request

    {
    "error": "Invalid token or password"
}