Skip to main content
The Email Password authentication allows your client to authenticate using email 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 email and password method.

Endpoint

​
POST
{auth_base_url}/email-password-signup
​
APP-KEY
string
required
App key of the particular project
POST the data in the application/json format.
​
email
string
required
Input email address of the user
​
password
string
required
Password of the user
​
is_verification
bool
If True, then a verification mail will be sent to the user’s mail-id. Default is False.
Email Verification Process - An Email verification link will be sent automatically to the user’s email address if is_verification is True. Upon clicking the link, the user’s email address will be verified automatically.
​
user_id
string
User Id of the new created user
​
email
string
Email address of the user
​
email_verification
string
If email verification is required then “pending”, else status is “verified” if verification not required.

​
Example

Request
POST https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/email-password-signup
HTTP/1.1
APP-KEY : ldM6yPAAE3PRTZbHXrjqGGzZY2Yjm7GwjAyjbNqWH48

{
   "email" : "[email protected]",
   "password": "user1234",
   "is_verification" : false
}
Response
HTTP/1.1
201 CREATED

{
   "user_id": "1",
   "email" : "[email protected]",
   "email_verification" : "verified"
}

​
2. Login API

This endpoints allows you to login a user using the email and password method.
​
POST
{auth_base_url}/email-password-login
​
APP-KEY
string
required
App key of the particular project
POST the data in the application/json format.
​
email
string
required
Email address of the user
​
password
string
required
Password of the user
​
user_id
string
User Id of the user
​
email
string
Email address of the user
​
email_verification
string
If email verification is required then “pending”, else status if “verified” if verification not required.
​
access_token
string
JWT access token is returned
​
token_type
string
Value is bearer
​
expires_in
string
Currently no expiry time for token, Returns null

​
Example

Request
POST https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/email-password-login
HTTP/1.1
APP-KEY : ldM6yPAAE3PRTZbHXrjqGGzZY2Yjm7GwjAyjbNqWH48

{
   "email" : "[email protected]",
   "password": "user1234"
}
Response
HTTP/1.1
200 OK

{
   "user_id": "1",
   "email" : "[email protected]",
   "email_verification" : "verified",
   "access_token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTIzNDU2Nzg5LCJuYW1lIjoiSm9zZXBoIn0.OpOSSw7e485LOP5PrzScxHb7SR6sAOMRckfFwi4rp7o",
   "token_type" :"bearer",
   "expires_in" : null
}

​
3. Password Reset API

This endpoints allows you to reset the password for the user.
​
POST
{auth_base_url}/email-password-reset
​
APP-KEY
string
required
App key of the particular project
​
email
string
required
Email address of the user
​
user_id
string
User Id of the new created user
​
email
string
Email address of the user
Password Reset Process - An Email password reset link will be sent automatically to the user’s email address. Upon clicking the link, the user will be redirected to password reset page where user can set his new password. You don’t need to create a webpage for password reset from your client end.

​
Example

Request
POST https://authn.zeromagic.cloud/auth/353d1499ab5149e194a53cf0f6c837f4/development/email-password-reset
HTTP/1.1
APP-KEY : ldM6yPAAE3PRTZbHXrjqGGzZY2Yjm7GwjAyjbNqWH48

{
   "email" : "[email protected]"
}
Response
HTTP/1.1
200 OK

{
   "user_id": "1",
   "email" : "[email protected]"
}