User Services
Configure user data management 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
The Kafka server is up and running
Encryption and MDMS services are running
PSQL server is running
The Redis database 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 the 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 |
---|---|---|
| 10 | default search record number limit |
| true | whether citizen login otp based |
| false | whether employee login otp based |
| 123456 | fixed otp for citizen |
| false | allow fixed otp for citizen |
| true | whether otp compulsory for registration |
| 10080 | validity time of access token |
| 20160 | validity time of refresh token |
| 90 | expiry date of a password |
| 60 | unlock time |
| 30 | window size for counting attempts for lock |
| 5 | max failed login attempts before account is locked |
| pb |
Integration Details
Integration Scope
User data management and functionality to log in and log out into the DIGIT system using OTP and password.
Integration Benefits
Providing the following functionalities 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
Integration Steps
To integrate, the host of egov-user should be overwritten in the 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, the OTP is sent to the user's mobile number and then the OTP is sent asotpReference
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 is validated (either through 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 users internally and should not be exposed outside.Forgot password: In case the user forgets the password it can be reset by first calling
/user-otp/v1/_send
which generates and sends OTP to the employeeâs mobile number. The password is then updated using this OTP by calling the API/password/nologin/_update
in which a new password along with the OTP is sent.Use
/password/_update
to update the existing password by logging in. Both old and new passwords are sent to the request body. Details of the API can be found in the attached swagger documentation.Use
/user/oauth/token
for generating tokens,/_logout
for logout and/_details
for getting user information from the token.Multi-Tenant User: The multi-tenant user functionality allows users to perform actions across multiple ULBs. For example, employees belonging to Amritsar can perform the role of say Trade License Approver for Jalandhar by assigning them the tenant-level role of tenantId pb.jalandhar.
Following is an example of the user:
If an employee has a role with statelevel tenantId
they can perform actions corresponding to that role across all tenants.
Refresh Token: Whenever the
/user/oauth/token
is called to generate theaccess_token
along withaccess_token,
one more token is generated calledrefresh_token
. The refresh token is used to generate a newaccess_token
whenever the existing one expires. Till the time the refresh token is valid, users will not have to log in even if theiraccess_token
expires since this is generated usingrefresh_token
. The validity time of the refresh token is configurable and can be configured using the property:refresh.token.validity.in.minutes
User Data Privacy
MDM Configuration For Security Policy
There are two security policy models for user data - User and UserSelf.
In model User, the field attributes
contains a list of fields from the user object that needs to be secured and the field roleBasedDecryptionPolicy
is an attribute-level role-based policy. It defines visibility for each attribute.
UserSelf model contains the same structure of security policy but the User security model is used for Search API response and UserSelf is used for Create/Update API response.
The visibility of the PII data is based on the above MDMS configuration. There are three types of visibility mentioned in the config.
PLAIN - Show text in plain form.
MASKED - The returned text contains masked data. The masking pattern is applied as defined in the Masking Patterns master data.
NONE - The returned text does not contain any data. It contains strings like âConfidential Informationâ.
Plain Access Request
Any user can get plain access to the secured data (citizenâs PII) by requesting through the plainAccessRequest
parameter. It takes the following parameters:
recordId
- It is the unique identifier of the record that is requested for plain access.fields
- It defines a list of attributes that are requested for plain access.
To know more about the encryption policy, refer to the document Encryption Service docs.
Reference Docs
Doc Links
API List
Last updated