Access Control

Access Control APIs

API specs to map actions to roles.

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

Get the list of actions based on the input parameters.

POST//access/v1/actions/_search

Query parameters

Body

*/*

Request info for getting actions.

apiId*string

unique API ID

ver*string

API version

ts*string

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

actionstring

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

didstring

device UUID from which API is called

keystring

API key (dynamic)

msgIdstring

unique request message id, UUID, for handling API idempotency

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token

Response

200400

Successful response

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

actionsarray of Action (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/actions/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "apiId": "text",
      "ts": "text",
      "ver": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "actions": [
    {
      "name": "text",
      "queryParams": "text",
      "url": "text",
      "displayName": "text",
      "enabled": false,
      "createdDate": "2024-11-21",
      "lastModifiedDate": "2024-11-21",
      "tenantId": "text"
    }
  ]
}

Create a new action.

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.

POST//access/v1/actions/_create

Body

*/*

Details for the new Action(s) entry + RequestInfo meta data.

requestInfo*RequestInfo_2 (object)

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.

actions*array of Action (object)

actionMasterstring

action master

enabledboolean

if enabled or not

featureIdsarray of integer

unique id for feature

leftIconstring

left icon

navigationURLstring

url for navigating

rightIconstring

right icon

roleCodesarray of string

codes specifying role

tenantIdstring

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

Response

200400

Action(s) created sucessfully

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

actionsarray of Action (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/actions/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "actions": [
        {
          "name": "text",
          "tenantId": "text"
        }
      ],
      "requestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "actions": [
    {
      "name": "text",
      "queryParams": "text",
      "url": "text",
      "displayName": "text",
      "enabled": false,
      "createdDate": "2024-11-21",
      "lastModifiedDate": "2024-11-21",
      "tenantId": "text"
    }
  ]
}

Update existing action(s).

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

PUT//access/v1/actions/_update

Body

*/*

Details for the Action(s) entry with new values + RequestInfo meta data.

requestInfo*RequestInfo_2 (object)

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.

actions*array of Action (object)

actionMasterstring

action master

enabledboolean

if enabled or not

featureIdsarray of integer

unique id for feature

leftIconstring

left icon

navigationURLstring

url for navigating

rightIconstring

right icon

roleCodesarray of string

codes specifying role

tenantIdstring

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

Response

200400

Update action(s) successful

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

actionsarray of Action (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/actions/_update', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "actions": [
        {
          "name": "text",
          "tenantId": "text"
        }
      ],
      "requestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      }
    }),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "actions": [
    {
      "name": "text",
      "queryParams": "text",
      "url": "text",
      "displayName": "text",
      "enabled": false,
      "createdDate": "2024-11-21",
      "lastModifiedDate": "2024-11-21",
      "tenantId": "text"
    }
  ]
}

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

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

POST//access/v1/actions/_validate

Body

*/*

Request info for getting actions.

requestInfoRequestInfo_2 (object)

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.

validateActionValidateAction (object)

Response

200400

Successful response without any content

Body

*/*

responseInfoResponseInfo (object)

actionValidationActionValidation (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/actions/_validate', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

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

Create mapping for feature and role.

Create mapping for feature and role.

POST//access/v1/feature-role/_create

Body

*/*

Request info for getting actions.

RequestInfoRequestInfo (object)

roleId*string

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

feature*Feature (object)

tenantId*string

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

Response

200400

Successful response

Body

*/*

RequestInfoResponseInfo (object)

roleRole (object)

featureFeature (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/feature-role/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "feature": {
        "name": "text",
        "tenantId": "text"
      },
      "roleId": "text",
      "tenantId": "text"
    }),
});
const data = await response.json();

Response

200400

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

Get the list of roles based on role codes.

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

POST//access/v1/roles/_search

Query parameters

Body

*/*

Request info for getting actions.

RequestInfoRequestInfo_2 (object)

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.

Response

200400

Successful response

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

rolesarray of Role_2 (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/roles/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roles": [
    {
      "name": "text",
      "description": "text",
      "code": "text",
      "createdDate": "2024-11-21",
      "lastModifiedDate": "2024-11-21"
    }
  ]
}

Create a new role.

To create new Role(s) in the system.

POST//access/v1/roles/_create

Body

*/*

Details for the new role(s) + RequestInfo meta data.

requestInfo*RequestInfo_2 (object)

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.

roles*array of Role_2 (object)

Response

200400

Role(s) created sucessfully

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

rolesarray of Role_2 (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/roles/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "requestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "roles": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roles": [
    {
      "name": "text",
      "description": "text",
      "code": "text",
      "createdDate": "2024-11-21",
      "lastModifiedDate": "2024-11-21"
    }
  ]
}

Update existing role(s).

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

PUT//access/v1/roles/_update

Body

*/*

Details for the Role(s) entry with new values + RequestInfo meta data.

requestInfo*RequestInfo_2 (object)

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.

roles*array of Role_2 (object)

Response

200400

Update role(s) successful

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

rolesarray of Role_2 (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/roles/_update', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "requestInfo": {
        "action": "text",
        "apiId": "text",
        "msgId": "text",
        "ver": "text"
      },
      "roles": [
        {
          "name": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "roles": [
    {
      "name": "text",
      "description": "text",
      "code": "text",
      "createdDate": "2024-11-21",
      "lastModifiedDate": "2024-11-21"
    }
  ]
}

Create mapping for role and action(s).

Create mapping for role and action(s).

POST//access/v1/role-actions/_create

Body

*/*

Details for the Role and Action(s) mapping + RequestInfo meta data.

requestInfoRequestInfo_2 (object)

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.

role*Role_2 (object)

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

actions*array of Action (object)

tenantId*string

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

Response

200400

Role - Action(s) mapping created sucessfully

Body

*/*

responseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

roleActionsarray of RoleAction (object)

Request

JavaScriptCurlPython

const response = await fetch('//access/v1/role-actions/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "actions": [
        {
          "name": "text",
          "tenantId": "text"
        }
      ],
      "role": {
        "name": "text"
      },
      "tenantId": "text"
    }),
});
const data = await response.json();

Response

200400

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