- 03 May 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
Policy Resolution
- Updated on 03 May 2024
- 4 Minutes to read
- Print
- DarkLight
- PDF
The Policy Resolution API enables you to create your own enforcement points when need to support access to large amounts of data (SQL, search engines, big data, etc.) or enforcement need to be done by another system/platform. It is designed to answer questions like: "What access filters need to be set up for a specific user to access an asset?". The response is expected to show the logical filtering of data and/or the list of allowed data items for the user.
Notice
When accessing the Authorization APIs, the URL base/prefix, according to your PlainID PDP LocationFor more information on which Asset Types to use with your PAA or Cloud PDP, refer to Managing Asset Types.
{
"entityId": "string",
"clientId": "string",
"clientSecret": "string",
"entityTypeId": "string",
"assetList": {
"type": [
{
"template": "string",
"path": "string",
"assetAttributes": {
"attribute_1": [
"string"
],
"attribute_2": [
"string"
]
}
}
]
},
"entityAttributes": [
"string"
],
"contextData": {
"string": [
"string"
]
},
"environment": {
"string": [
"string"
]
},
"remoteIp": "string",
"timeZoneOffset": 0.0,
"resourceTypes": {
"name": "string",
"attributeList": "-string"
},
"includeContext": false,
"includeAccessPolicy": false,
"includeAccessPolicyId": false,
"includeAssetAttributes": false,
"includeIdentity": false,
"accessTokenFormat": "string",
"useCache": false
}
Unique identifier of the Identity
Client ID of the Scope
Client Secret ID of the Scope
Identity Template ID
List of Identity Attributes and their values.
If not defined, Dynamic groups based on virtual attriutes will not be considered in the Access Decision.
Identity Context data for this request. When specifying this parameter, you are requesting information based on a specific parameter and its value.
For example, Location where the contextData equals a specific branch.
If not defined, Dynamic groups based on context data will not be considered in the Access Decision.
Attributes and their values used in Advanced Conditions or Request Parameters used In Asset Rules.
Environmental parameters need to be defined in policies as request.
If not defined, parametes based on emviromental data will not be considered in the Access Decision.
IP address to be used when validating a policy. Ensure that your IP Ranges are correct based on an IP calculator. If not defined, the IP considered in the calculation is taken from the X-Forwarded-For (Request header).
To define the offset from UTC time zone. Used in Time Condition.
Contains a list of the Asset's unique identifier and attributes:
Asset Template ID
Asset Unique Identifier
Because the full payload of the response can be very large, this parameter enables you to decrease the payload size by including a list of Asset Types and their attributes, that will return in the response.
If not specified, all resources from all resource types will be included.
Show/hide the context data in the response.
Show/hide the name of the Policy in the response that has granted the specified access.
Show/hide the external id of the Policy in the response that granted the specified access.
Show/hide the asset attribute of the assets in the response.
Show/hide the identity attribute of the identity in the response.
Determines the format of the response – whether JSON or JWT.
The attribute will determine if the response will consider the cache settings or override the cache and preforming full calculation.
Determines the evaluation of Identity Attributes relationship in access decision.
An auto-generated key to set the correlation between the requested object and the response object (optional). When working with a single assetContext object, use the “singleObjectResponse” value to align to the original structure response.
These operational filters should affect the Runtime behavior and results by applying additional filtering which is not directly related to Authorization logic.
Input your sourceID/s here. For information on where to locate the sourceID, check out Managing Attribute Sources in our documentation.
OK
{
"tokenValidity": 0,
"response": [
{
"access": [],
"privileges": {
"allowed": [
{
"resourceType": "Accounts",
"actions": [
{
"action": "Access",
"asset-attributes-filter": {
"OR": [
{
"OR": [
{
"AND": [
{
"attribute": "location",
"type": "STRING",
"operator": "EQUALS",
"values": [
"Alabama"
],
"match": "any"
}
]
}
]
}
]
}
}
]
}
],
"denied": []
}
}
]
}
An auto-generated key to set the correlation between the requested object and the response object (optional). When working with a single assetContext object, use the “singleObjectResponse” value to align to the original structure response.
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Not Implemented