User Services

Overview

User service is responsible for user data management and providing functionality to login and logout into the DIGIT system

Pre-requisites

Before you proceed with the configuration, make sure the following pre-requisites are met -

Java 8
Kafka server is up and running
Encryption and MDMS services are running
PSQL server is running and a database
Redis is running

Key Functionalities

Store, update and search user data
Provide authentication
Provide login and logout functionality into the DIGIT platform
Store user data PIIs in encrypted form

Interaction Diagram

Deployment Details

Setup latest version of egov-enc-service and egov-mdms- service
Deploy the latest version of egov-user service
Add Role-Action mapping for APIs

Configuration Details

The following application properties file in user service are configurable.

Property

Value

Remarks

egov.user.search.default.size

default search record number limit

citizen.login.password.otp.enabled

true

whether citizen login otp based

employee.login.password.otp.enabled

false

whether employee login otp based

citizen.login.password.otp.fixed.value

123456

fixed otp for citizen

citizen.login.password.otp.fixed.enabled

false

allow fixed otp for citizen

otp.validation.register.mandatory

true

whether otp compulsory for registration

access.token.validity.in.minutes

10080

validity time of access token

refresh.token.validity.in.minutes

20160

validity time of refresh token

default.password.expiry.in.days

expiry date of a password

account.unlock.cool.down.period.minutes

unlock time

max.invalid.login.attempts.period.minutes

window size for counting attempts for lock

max.invalid.login.attempts

max failed login attempts before account is locked

egov.state.level.tenant.id

Integration Details

Integration Scope

User data management and functionality to login and logout into Digit system using OTP and password.

Integration Benefits

Providing the following functionality to citizen and employee-type users

Employee:
- User registration
- Search user
- Update user details
- Forgot password
- Change password
- User role mapping(Single ULB to multiple roles)
- Enable employees to login into the DIGIT system based on a password.
Citizen:
- Create user
- Update user
- Search user
- User registration using OTP
- OTP based login

Steps to Integration

To integrate, the host of egov-user should be overwritten in the helm chart.
Use /citizen/_create and /users/_createnovalidate endpoints for creating users into the system
Use /v1/_search and /_search endpoints to search users in the system depending on various search parameters
Use /profile/_update for partial update and /users/_updatenovalidate for update
Use /password/nologin/_update for otp based password reset and /password/_update for logged in user password reset
Use /user/oauth/token for generating token, /_logoutfor logout and /_details for getting user information from his token