This section provides detailed information about the authentication API provided by our platform. It includes the necessary endpoints, request parameters, and response formats.

Endpoints

  • GET /api/v1/auth/login: Used to authenticate a user and retrieve a session token.
  • POST /api/v1/auth/register: Allows new users to register an account.
  • GET /api/v1/auth/logout: Ends the current user session.

Request Parameters

Login Endpoint

  • username: The username of the user.
  • password: The password of the user.

Register Endpoint

  • username: The desired username for the new account.
  • password: The password for the new account.
  • email: The email address associated with the account.

Response Formats

All endpoints return JSON responses. Here's an example of a successful login response:

{
  "status": "success",
  "message": "User authenticated successfully.",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

Image

![Authentication Flow Diagram](https://cloud-image.ullrai.com/q/Authentication_Flow Diagram/)

For more detailed information, please refer to our API Reference.

If you have any further questions or issues, please reach out to our support team at support@ullrai.com.