Skip to main content
The Username with Password authentication allows your client to authenticate using username and password method. The endpoints are pre-built and are easy to manage your authentication flow and users. To get your {auth_base_url}, check it out here - Get started with base url.
Note : APP-KEY to be passed in Headers can be obtained from the settings in the project dashboard

​
1. Signup API

This endpoints allows you to create a new user using the username and password method.

Endpoint

​
{auth_base_url}/username-password-signup
​
string
required
App key of the particular project
POST the data in the application/json format.
​
string
required
Username of the user. Check out the username format here
​
string
required
Password of the user
​
string
User Id of the new created user
​
string
Username of the user

​
Example

Request
Response

​
2. Login API

This endpoints allows you to login a user using the username and password method.
​
{auth_base_url}/username-password-login
​
string
required
App key of the particular project
POST the data in the application/json format.
​
string
required
Username of the user. Check out the username format here
​
string
required
Password of the user
​
string
User Id of the user
​
string
Username of the user
​
string
JWT access token is returned
​
string
Value is bearer
​
string
Currently no expiry time for token, Returns null

​
Example

Request
Response

​
Username

  • The username must be between 4 and 20 characters long.
  • The username can only contain alphanumeric characters (letters and digits) and underscores.
  • The username cannot contain any spaces.
  • The username must begin with a letter (a-z or A-Z).
Examples