User Service

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

Open

Open

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.

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 password can then be updated using this otp by calling API /password/nologin/_update in which new password along with the otp has to be send

• Use /password/_update to update existing password by logging in. In request body both old and new password has to be sent. Details of the API can be found in the attached swagger documentation

• Use /user/oauth/token for generating token, /_logoutfor logout and /_details for getting user information from his token

• Multi Tenant User : The Multi tenant User functionality allows an user to perform actions across multiple ULB’s. For example an employee belonging to Amritsar can perform an role of say Trade License Approver for Jalandhar by assigning a tenant level role of tenantId pb.jalandhar to him. Following is an example of such user:
  
  

  { "id": 24226, "uuid": "11t0e02b-0145-4de2-bc42-c97b96264807", "userName": "xyz", "name": "abc", "mobileNumber": "9999999999", "emailId": "abc@gmail.com", "locale": null, "type": "EMPLOYEE", "roles": [ { "name": "Employee", "code": "EMPLOYEE", "tenantId": "pb.amritsar" }, { "name": "TL Approver", "code": "TL_APPROVER", "tenantId": "pb.jalandhar" } ], "active": true, "tenantId": "pb.amritsar" }

  
  If an employee has a role with statelevel tenantId he can perform actions corresponding to that role across all tenants

• Refresh Token : Whenever the /user/oauth/token is called to generate the access_token , along with the access_token one more token is generated called refresh_token . The refresh token is used to generate new access_token whenever the existing one expires. Till the time the refresh token is valid the user won’t have to login even if his access_token get’s expired, as it will be generated using refresh_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

Mdms configuration for security policy

There are two security policy model for user data, User and UserSelf.
In model User, under field attributes contains list of fields from the User object that needs to be secured and field roleBasedDecryptionPolicy is an attribute-level role-based policy. It will define visibility for each attribute.

UserSelf model contains the same structure of security policy, but User security model is used for Search API response and UserSelf is used for Create / Update API response.

Visibility of the PII data is based on the above mdms configuration. There are three type of visibility mentioned in the config.

1. PLAIN - Show text in plain form.

2. MASKED - The returned text will contain masked data. The masking pattern will be applied as defined in the Masking Patterns master data.

3. NONE - The returned text will not contain any data. It would contain string like “Confidential Information”.

Plain Access Request

Any user will be able to get plain access to the secured data(citizen’s PII) by requesting through the plainAccessRequest parameter. It takes the following parameters:

1. recordId - It is the unique identifier of the record that is requested for plain access.

2. fields - It defines a list of attributes that are requested for plain access.
   
   

To know more about the encryption policy, refer to document Encryption Service mentioned in Reference Docs.

Reference Docs

Doc Links

API List

 (Note: All the API’s are in the same postman collection therefore same link is added in each row)