User Service

Owned by Gopesh Yadav (Unlicensed)
Last updated: Jun 09, 2022 by Rohit shende (Unlicensed)
6 min read

Overview

User service is responsible for user data management and providing functionality to login and logout into 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 database

  • Redis is running

Key Functionalities

  • Store, update and search user data

  • Provide authentication

  • Provide login,logout functionality into DIGIT platform

  • Store user data PIIs in encrypted form

Interaction Diagram

 

 

Deployment Details

  1. Setup latest version of egov-enc-service and egov-mdms- service

  2. Deploy latest version of egov-user service

  3. Add Role-Action mapping for API’s

Configuration Details

Following are the properties in application.properties file in user service which are configurable.

Property

Value

Remarks

Property

Value

Remarks

egov.user.search.default.size

10

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

90

expiry date of a password

account.unlock.cool.down.period.minutes

60

unlock time

max.invalid.login.attempts.period.minutes

30

window size for counting attempts for lock

max.invalid.login.attempts

5

max failed login attempts before account is locked

egov.state.level.tenant.id

pb

 

Integration

 

Integration Scope

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

Integration Benefits

Providing 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 role)

    • Enable employee to login into DIGIT system based on password.

  • Citizen:

    • Create user

    • Update user

    • Search user

    • User registration using OTP

    • OTP based login

Steps to Integration

  • To integrate, host of egov-user should be overwritten in helm chart.

  • Use /citizen/_create endpoint for creating users into the system. This endpoint requires the user to validate his mobile Number using otp. First otp will be send to his mobile number and then that otp will be send as otpReference in the request body

  • Use /v1/_search and /_search endpoints to search users in the system depending on various search parameters

  • Use /profile/_update for updating the user profile. The user will be validated (either by otp based validation or password validation) when this API is called

  • /users/_createnovalidate and /users/_updatenovalidate are endpoints to create user data into the system without any validations (no otp or password required). They should be strictly used only for creating/updating user’s internally and should not be exposed outside

  • Forgot password: In case the user forgets password it can be reset by first calling /user-otp/v1/_send which will generate and send otp on employee’s mobile number, the pa