Access Control

Access Control APIs

API specs to map actions to roles.

Get the list of actions based on either roles or features.

post

Get the list of actions based on the input parameters.

Query parameters

rolesstring[]optional

The list of role codes.

featuresinteger[]optional

The list of feature id's.

Body

apiIdstringrequired

unique API ID

verstringrequired

API version

tsstringrequired

response timestamp YYYY-MM-DDThh:mm:ss+/-nn:nn (timezone defaulted to +5.30)

actionstringoptional

api action like GET/POST/PUT/DELETE in case of http calls

didstringoptional

device UUID from which API is called

keystringoptional

API key (dynamic)

msgIdstringoptional

unique request message id, UUID, for handling API idempotency

requesterIdstringoptional

UserId of the user calling

authTokenstringoptional

//session/jwt/saml token/oauth token

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/actions/_search' \
  --header 'Content-Type: */*' \
  --data '{
    "apiId": "text",
    "ver": "text",
    "ts": "text",
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "actions": [
    {
      "id": 1,
      "name": "text",
      "queryParams": "text",
      "url": "text",
      "parentModule": 1,
      "orderNumber": 1,
      "displayName": "text",
      "enabled": true,
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27",
      "tenantId": "text",
      "serviceCode": 1
    }
  ]
}

Successful response

Create a new action.

post

To create new action(s) in the system. An action entry is required for each and every path to authenticate the access based on the assigned role of an user.

Body

requestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

actionsobject[]required

actionMasterstringoptional

action master

enabledbooleanoptional

if enabled or not

featureIdsinteger[]optional

unique id for feature

leftIconstringoptional

left icon

navigationURLstringoptional

url for navigating

rightIconstringoptional

right icon

roleCodesstring[]optional

codes specifying role

tenantIdstringoptional

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/actions/_create' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    },
    "actions": [
      {
        "id": 1,
        "name": "text",
        "queryParams": "text",
        "url": "text",
        "parentModule": 1,
        "orderNumber": 1,
        "displayName": "text",
        "enabled": true,
        "createdBy": 1,
        "createdDate": "2025-03-27",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-03-27",
        "tenantId": "text",
        "serviceCode": 1
      }
    ],
    "actionMaster": "text",
    "enabled": true,
    "featureIds": [
      1
    ],
    "leftIcon": "text",
    "navigationURL": "text",
    "rightIcon": "text",
    "roleCodes": [
      "text"
    ],
    "tenantId": "text"
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "actions": [
    {
      "id": 1,
      "name": "text",
      "queryParams": "text",
      "url": "text",
      "parentModule": 1,
      "orderNumber": 1,
      "displayName": "text",
      "enabled": true,
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27",
      "tenantId": "text",
      "serviceCode": 1
    }
  ]
}

Action(s) created sucessfully

Update existing action(s).

put

To update the existing action(s) in the system.

Body

requestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

actionsobject[]required

actionMasterstringoptional

action master

enabledbooleanoptional

if enabled or not

featureIdsinteger[]optional

unique id for feature

leftIconstringoptional

left icon

navigationURLstringoptional

url for navigating

rightIconstringoptional

right icon

roleCodesstring[]optional

codes specifying role

tenantIdstringoptional

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//access/v1/actions/_update' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    },
    "actions": [
      {
        "id": 1,
        "name": "text",
        "queryParams": "text",
        "url": "text",
        "parentModule": 1,
        "orderNumber": 1,
        "displayName": "text",
        "enabled": true,
        "createdBy": 1,
        "createdDate": "2025-03-27",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-03-27",
        "tenantId": "text",
        "serviceCode": 1
      }
    ],
    "actionMaster": "text",
    "enabled": true,
    "featureIds": [
      1
    ],
    "leftIcon": "text",
    "navigationURL": "text",
    "rightIcon": "text",
    "roleCodes": [
      "text"
    ],
    "tenantId": "text"
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "actions": [
    {
      "id": 1,
      "name": "text",
      "queryParams": "text",
      "url": "text",
      "parentModule": 1,
      "orderNumber": 1,
      "displayName": "text",
      "enabled": true,
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27",
      "tenantId": "text",
      "serviceCode": 1
    }
  ]
}

Update action(s) successful

Validate a particular action for a given tenant and roles of the tenant

post

Validate a particular action for a given tenant and roles of the tenant.

Body

requestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

validateActionobjectoptional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/actions/_validate' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    },
    "validateAction": {
      "tenantRole": {
        "tenantId": "text",
        "roles": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ]
      },
      "actionUrl": "text"
    }
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "actionValidation": {
    "allowed": true
  }
}

Successful response without any content

Create mapping for feature and role.

post

Create mapping for feature and role.

Body

RequestInfoobjectoptional

roleIdstringrequired

List of Role Id to be provided for mapping it to feature.

featureobjectrequired

tenantIdstringrequired

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/feature-role/_create' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": "text",
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "roleId": "text",
    "feature": {
      "id": 1,
      "code": 1,
      "name": "text",
      "description": "text",
      "serviceCode": 1,
      "tenantId": "text"
    },
    "tenantId": "text"
  }'

200

400

200

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "text"
  },
  "role": {
    "id": 1,
    "name": "text"
  },
  "feature": {
    "id": 1,
    "code": 1,
    "name": "text",
    "description": "text",
    "serviceCode": 1,
    "tenantId": "text"
  }
}

Successful response

Get the list of roles based on role codes.

post

Get the list of roles based on role codes in the input parameters.

Query parameters

codestring[]optional

The list of comma separated codes to filter Roles against. No providing any would end up in all Roles as there is nothing to filter against

Body

RequestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/roles/_search' \
  --header 'Content-Type: */*' \
  --data '{
    "RequestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    }
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roles": [
    {
      "name": "text",
      "description": "text",
      "id": 1,
      "code": "text",
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27"
    }
  ]
}

Successful response

Create a new role.

post

To create new Role(s) in the system.

Body

requestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

rolesobject[]required

minimal representation of the Roles in the system to be carried along in UserInfo with RequestInfo meta data. Actual authorization service to extend this to have more role related attributes

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/roles/_create' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    },
    "roles": [
      {
        "name": "text",
        "description": "text",
        "id": 1,
        "code": "text",
        "createdBy": 1,
        "createdDate": "2025-03-27",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-03-27"
      }
    ]
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roles": [
    {
      "name": "text",
      "description": "text",
      "id": 1,
      "code": "text",
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27"
    }
  ]
}

Role(s) created sucessfully

Update existing role(s).

put

To update the existing role(s) in the system.

Body

requestInfoobjectrequired

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

rolesobject[]required

minimal representation of the Roles in the system to be carried along in UserInfo with RequestInfo meta data. Actual authorization service to extend this to have more role related attributes

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '//access/v1/roles/_update' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    },
    "roles": [
      {
        "name": "text",
        "description": "text",
        "id": 1,
        "code": "text",
        "createdBy": 1,
        "createdDate": "2025-03-27",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-03-27"
      }
    ]
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roles": [
    {
      "name": "text",
      "description": "text",
      "id": 1,
      "code": "text",
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27"
    }
  ]
}

Update role(s) successful

Create mapping for role and action(s).

post

Create mapping for role and action(s).

Body

requestInfoobjectoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

roleobjectrequired

minimal representation of the Roles in the system to be carried along in UserInfo with RequestInfo meta data. Actual authorization service to extend this to have more role related attributes

actionsobject[]required

tenantIdstringrequired

Unique Identifier of the tenant, Like AP, AP.Kurnool etc.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '//access/v1/role-actions/_create' \
  --header 'Content-Type: */*' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text",
      "userInfo": {
        "tenantId": "text",
        "id": 1,
        "userName": "text",
        "mobile": "text",
        "email": "text",
        "primaryrole": [
          {
            "name": "text",
            "description": "text",
            "id": 1,
            "code": "text",
            "createdBy": 1,
            "createdDate": "2025-03-27",
            "lastModifiedBy": 1,
            "lastModifiedDate": "2025-03-27"
          }
        ],
        "additionalroles": [
          {
            "tenantId": "text",
            "roles": [
              {
                "name": "text",
                "description": "text",
                "id": 1,
                "code": "text",
                "createdBy": 1,
                "createdDate": "2025-03-27",
                "lastModifiedBy": 1,
                "lastModifiedDate": "2025-03-27"
              }
            ]
          }
        ]
      }
    },
    "role": {
      "name": "text",
      "description": "text",
      "id": 1,
      "code": "text",
      "createdBy": 1,
      "createdDate": "2025-03-27",
      "lastModifiedBy": 1,
      "lastModifiedDate": "2025-03-27"
    },
    "actions": [
      {
        "id": 1,
        "name": "text",
        "queryParams": "text",
        "url": "text",
        "parentModule": 1,
        "orderNumber": 1,
        "displayName": "text",
        "enabled": true,
        "createdBy": 1,
        "createdDate": "2025-03-27",
        "lastModifiedBy": 1,
        "lastModifiedDate": "2025-03-27",
        "tenantId": "text",
        "serviceCode": 1
      }
    ],
    "tenantId": "text"
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roleActions": [
    {
      "roleCode": "text",
      "actionId": 1,
      "tenantId": "text"
    }
  ]
}

Role - Action(s) mapping created sucessfully