Login

API Documentation

Login

Login API authenticates a user’s credentials and provides access to the system. This endpoint is essential for initiating user sessions.

Endpoint:

Post /
/api/v1/User/Login

Request Parameters

UserName String (Required)

The user’s username (used during sign-in). Email address can be used as long as it is unique within the system. Note: even if the user will be using an external authentication provider, the username properties should still be provided.

Password String (Required)

The user’s password (used during sign-in). Note: even if the user will be using an external authentication provider, the password properties should still be provided. The user will be prompted to reset their password on the next sign in.

				
					{
  "password": "Password@123",
  "userName": "groge.joy"
}

Response

Success Boolean (Not Nullable)

Indicates whether valid API request or not

Message String(Nullable)

The messsage provide for success or failure response.

Data User(Nullable)

Sends the userdetails fetched by username if it is valid.

  • FirstName
  • LastName
  • UserId
  • EmailAddress
  • AccessToken
				
					{
  "success": true,
  "message": "Record retrieved successfully.",
  "data": {
    "firstName": "Abc",
    "lastName": "Xyz",
    "userId": 1,
    "emailAddress": "abc@xyz.com",
    "accessToken": "eyJhbGciOiJIUdsfsffsfggsgsgdsgdgkpXVCJ9.c3Mzc0MSwiaWF0IjoxNzE1Njg3MzQxfQ.d5O80jp93d5nhqpGks-4eqvupRZizy9eQpMV-WvPUqI"
  }
}