User OTP Service
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 sends the OTP to the user on login requests, on password change requests 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 APIs.
Integration
Integration Scope
User-OTP service handles the OTP for user registration, user log in 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 citizens then it can be done easily.
Steps to Integration
To integrate, a host of user-otp modules should be overwritten in the 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 sends the OTP to the user via SMS or email based on the below parameters:
Input Field
Description
Mandatory
Data Type
Input Field
Description
Mandatory
Data Type
tenantId
Unique id for a tenant.
Yes
String
mobileNumber
Mobile number of the user
Yes
String
type
OTP type ex: login/register/password reset
Yes
String
userType
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 the user mobile number.org.egov.core.notification.email:- This topic is used to send OTP to the user email id.
Last updated
