Overview
User-OTP service handles the OTP for user registration, user login and password reset for a particular user.
Pre-requisites
Before you proceed with the documentation, make sure the following pre-requisites are met -
Java 8
egov-user service is running
egov-localization service is running
egov-otp service is running
Key Functionalities
The user-otp service send the OTP to user on login request, on password change request and during new user registration.
Deployment Details
Deploy the latest version of user-otp.
Make sure egov-otp is running.
Add Role-Action mapping for API’s.
Integration
Integration Scope
User-OTP service handles the OTP for user registration, user login and password reset for a particular user.
Integration Benefits
Can perform user registration, login, password reset.
In the future, if we want to expose the application to citizen then it can be done easily.
Steps to Integration
To integrate, host of user-otp module should be overwritten in helm chart.
/user-otp/v1/_sendshould be added as the endpoint for sending OTP to the user via sms or email
Reference Docs
Doc Links
Title | Link |
API Postman Collection |
API Details
BasePath /user-otp/v1/[API endpoint]
Method
a) POST /_send
This method send the OTP to user via sms or email based on the below parameter
Input Field | Description | Mandatory | Data Type |
|---|---|---|---|
| Unique id for a tenant. | Yes | String |
| Mobile number of the user | Yes | String |
| OTP type ex: login/register/password reset | Yes | String |
| Type of user ex: Citizen/Employee | No | String |
Producers
Following are the Producer topic.
egov.core.notification.sms.otp:- This topic is used to send OTP to user mobile number.org.egov.core.notification.email:- This topic is used to send OTP to user email id.
...