The Policy List API call returns the relevant policies for each input object with their meta data.
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.
Important note about headers
Refer to the headers below to modify your cURL sample. Check if the following headers are in the sample, if not, ensure you add it to your cURL sample before pasting into your API tool.
Headers
*RequiredHeader | Value | cURL Line |
---|---|---|
content-type | `application/json` | `-H 'Content-Type: application/json' ` |
cURL Sample Guidelines
In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.
For more details about Administration API Authentication, check out the Authentication APIs documentation
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Client ID of the Scope
The Client ID is required, ensure that it is defined either in the header as X-Client-Id
or in the body as clientId
.
Client Secret ID of the Scope.
You can also authenticate with an Authorization Token (in your API tool). Note that the X-Client-Id is still required, whether in the header or the body. Refer to Setting up an Authentication Method for more information.
All Access Token and UserList request parameters
Asset Template ID (required)
Unique Identifier of the Asset (required)
Name of the Action (optional)
(optional)
Unique identifier of the Identity
Identity Template ID
List of Identity Attributes and their values.
If not defined, Dynamic groups based on virtual attributes 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.
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). 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
The Attribute will determines if the response will consider the cache settings or override the cache and preforming full calculation.
An auto-generated key to set the correlation between the requested object and the response object (optional).
Fail request when Attribute calculation fails.
Each object input gets a list of Policies
All Access Token and UserList request parameters
An auto-generated key to set the correlation between the requested object and the response object (optional).
Asset Template ID (required)
Unique Identifier of the Asset (required)
Name of the Action (optional)
(optional)
Unique identifier of the Identity
Client ID of the Scope
Client Secret ID of the Scope.
You can also authenticate with an Authorization Token (in your API tool).
Identity Template ID
List of Identity Attributes and their values.
If not defined, Dynamic groups based on virtual attributes 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.
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). 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
The Attribute will determines if the response will consider the cache settings or override the cache and preforming full calculation.
Additional response metadata. This response is only returned when the includeAccessPolicy
is set to true, and when the permissionMetadata
object contains one or more properties
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Not Implemented