Detail Policy Set by ID
This API returns detailed information about a specific policy set identified by ID.
Endpoint Details
| URL | /v1/config-agent/policy-sets/id |
| Method | GET |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Path
To retrieve the details of a specific policy set, use the following request format:
/v1/config-agent/policy-sets/553e852b-77d8-461c-9727-2ab342341dc7
Path Parameter
| Parameter | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the policy set |
Response
Here is an example of a response when viewing data details:
Response
{
"data": {
"id": "553e852b-77d8-461c-9727-2ab342341dc7",
"tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
"name": "Dummy",
"type": "PolicyTypeDirectory",
"security_rules": [
{
"user_set_id": "95811aa4-5b61-46d3-a007-14d0a576ef60",
"resource_set_id": "ed7cced2-2c8a-4779-b8e6-408f4a28a4b3",
"process_set_id": "b09b02eb-a75c-47d3-b32f-08de49350c34",
"action_policy": {
"read": true,
"write": true,
"all_operations": true,
"key_operation": true
},
"effect_policy": {
"effect_permission": true,
"apply_key": true
},
"allow_browsing": true
}
],
"key_rules": [
{
"resource_set_id": "ed7cced2-2c8a-4779-b8e6-408f4a28a4b3",
"key_id": "8471d88d-feda-4d0f-bb39-7f45d8976b94"
}
],
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_by_name": "Admin Aplikasi",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by_name": "Admin Aplikasi",
"created_at": 1785296752,
"updated_at": 1785296752
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the policy set |
| tenant_id | UUID | Identifier of the tenant that owns the policy set |
| name | String | Name of the policy set |
| description | String | Description of the policy set |
| type | String | Type of the policy set |
| security_rules | Array | List of security rules applied by the policy |
| user_set_id | UUID | Identifier of the user set the rule applies to |
| resource_set_id | UUID | Identifier of the resource set the rule applies to |
| process_set_id | UUID | Identifier of the process set the rule applies to |
| action_policy | Object | Actions the rule permits |
| read | Boolean | Whether read is permitted |
| write | Boolean | Whether write is permitted |
| all_operations | Boolean | Whether all operations are permitted |
| key_operation | Boolean | Whether key operations are permitted |
| effect_policy | Object | Effects applied when the rule matches |
| effect_permission | Boolean | Whether the permission effect is applied |
| apply_key | Boolean | Whether the key is applied |
| allow_browsing | Boolean | Whether browsing is allowed |
| key_rules | Array | List of key rules that bind resource sets to encryption keys |
| resource_set_id | UUID | Identifier of the resource set the key applies to |
| key_id | UUID | Identifier of the encryption key applied to the resource set |
| created_by | UUID | Identifier of the user who created the policy |
| created_by_name | String | Display name of the user who created the policy |
| updated_by | UUID | Identifier of the user who last updated the policy |
| updated_by_name | String | Display name of the user who last updated the policy |
| created_at | Integer | Creation timestamp in Unix format |
| updated_at | Integer | Last update timestamp in Unix format |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing policy set. - Supported
typevalues arePolicyTypeDirectoryandPolicyTypeObjectStorage. - In
action_policyandeffect_policy, only actions set totrueare returned. - Unix timestamp fields can be converted to a human-readable date and time format as needed.