Access Control Services

Configure role based user access and map actions to roles

Overview

DIGIT is an API-based platform where each API denotes a DIGIT resource. The primary job of Access Control Service (ACS) is to authorise end-users based on their roles and provide access to the DIGIT platform resources. Access control functionality is essentially based on the following points:

Actions: Actions are events performed by a user. This can be an API end-point or front-end event. This is the MDMS master.

Roles: Roles are assigned to users. A single user can hold multiple roles. Roles are defined in MDMS masters.

Role-Action: Role actions are mapped between Actions and Roles. Based on roles, the action mapping access control service identifies applicable actions for the role.

Pre-requisites

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

• Java 17

• MDMS service is up and running

Key Functionalities

• Serve the applicable actions for a user based on user roles.

• On each action performed by a user, access control looks at the user's roles and validates actions that map with the role.

• Support tenant-level role action - For instance, an employee from Amritsar can have the role of APPROVER for other ULBs like Jalandhar and hence will be authorised to act as APPROVER in Jalandhar.

Play around with the APIs: DIGIT-Playground

Deployment Details

1. Deploy the latest version of the Access Control Service

   • Note: This video will give you an idea of how to deploy any Digit-service. Further, you can find the latest builds for each service in our latest release document here.

2. Deploy service to fetch the Role Action Mappings

   • Note: This video will give you an idea of how to deploy any Digit-service. Further, you can find the latest builds for each service in our latest release document here.

Configuration Details

Define the roles:

{
      "code": "EMPLOYEE",
      "name": "Employee",
      "description": "Default role for all employees"
}

Add the actions (URL)

{
      "id": {{ACTION_ID}},
      "name": "Create TradeLicense",
      "url": "/tl-services/v1/_create",
      "parentModule": "",
      "displayName": "Create TradeLicense",
      "orderNumber": 0,
      "enabled": false,
      "serviceCode": "tl-services",
      "code": "null",
      "path": ""
}

Add the role action mapping

{
      "rolecode": "EMPLOYEE",
      "actionid": {{ACTION_ID}},
      "actioncode": "",
      "tenantId": "pb"
    }

The details about the fields in the configuration can be found in the Swagger contract

Integration Details

Integration Scope

Any service that requires authorisation can leverage the functionalities provided by the access control service.

Integration Benefits

To add a new service to the platform, simply update its role action mapping in the master data. The Access Control Service will handle authorisation each time the microservice API is called.

Integration Steps

1. To integrate with the Access Control Service the role action mapping has to be configured (added) in the MDMS service.

2. The service needs to call /actions/_authorize API of Access Control Service to check for authorisation of any request.

Interaction Diagram

Reference Docs

Doc Links

Title
API Contract

API List

Title	Link
/actions/_authorize	[LINK TO BE UPDATED]