Clients Policies Report
The Clients Policies Report shows the mapping of clients with the policies applied to them on the CipherTrust Manager.
Generating the Report
Use the get /v1/transparent-encryption/reports/clients-profiles API to generate the report. Columns in the report can be filtered using the request query parameters.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/clients-profiles/?sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| client_name | string | (optional) Name of the client. If not specified, the report will contain policies applied to all clients. |
| os_type | string | (optional) Operating system running on the client - LINUX, WINDOWS, or UNKNOWN. If not specified, the report will contain policies applied to clients running any OS. Specify UNKNOWN for the unregistered or manually added clients. |
| policy_name | string | (optional) Name of the policy applied to the client. If not specified, the report will contain all policies applied to the clients. |
| policy_type | string | (optional) Type of the policy. The options are: STANDARD, IDT, LDT, and Cloud_Object_Storage. If not specified, the report will contain policies of all types. |
| guard_enabled | string | (optional) Whether the linked GuardPoint is enabled. If not specified, the report will contain all records irrespective of whether a GuardPoint is enabled or not. |
| sort | string | Comma-delimited list of columns to sort the results. Multiple fields are sorted by multi-field sort. By default, the results are sorted in alphabetic ascending order. To change the sort order, precede the field by a - (minus) sign. |
| skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
| limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/clients-policies/?sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 3,
"resources": [
{
"client_name": "client_001",
"os_type": "LINUX",
"policy_name": "hr_policy",
"policy_type": "STANDARD",
"guard_enabled": "true",
},
{
"client_name": "client_002",
"os_type": "WINDOWS",
"policy_name": "it_policy",
"policy_type": "IDT",
"guard_enabled": "true",
},
{
"client_name": "client_003",
"os_type": "LINUX",
"policy_name": "test_policy",
"policy_type": "LDT",
"guard_enabled": "true",
}
]
}
The output shows the mapping of clients with the policies applied to them. You can download the report as a PDF or CSV document, as required. Refer to Downloading the Report.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
Downloading the Report
Use the get /v1/transparent-encryption/reports/clients-policies/download API to download the report as a PDF or CSV document.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/clients-policies/download/?report_type=<report_type>' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| report_type | string | (Mandatory) Format of the report to download. The options are pdf and csv. |
Request Query Parameters
Refer to Request Query Parameters. You can omit these fields from the downloaded report. Specify the fields to omit in the omit_fields parameter.
| Parameter | Type | Description |
|---|---|---|
| os_type | string | Operating system running on the client - LINUX, WINDOWS, or UNKNOWN. |
| policy_type | string | Type of the policy. The options are: STANDARD, IDT, LDT, and Cloud_Object_Storage. |
| guard_enabled | string | Whether the linked GuardPoint is enabled - true or false. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/clients-policies/download/?report_type=pdf&sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
CSV
If you specified report_type as csv, the report is downloaded as a CSV document named, cte_clients_policies_<TIMESTAMP>.csv, for example, cte_clients_policies_2021-01-12T07_08_43Z.csv.
If you specified report_type as pdf, the report is downloaded as a PDF document named, cte_clients_policies_<TIMESTAMP>.pdf, for example, cte_clients_policies_2021-01-12T07_08_50Z.pdf.
The downloaded PDF document shows the Report Name as Clients Policies Report and time the report is Generated At.
Viewing the Report
Based on the parameters specified during the API call, the downloaded report shows all or some of the following columns:
| Column | Description |
|---|---|
| Client Name | Name of the client on the CipherTrust Manager. |
| OS Type | Operating system running on the client - LINUX, WINDOWS, or UNKNOWN. For unregistered or manually added clients, UNKNOWN is displayed. |
| Policy Name | Name of the applied policy. |
| Policy Type | Type of the policy. |
| Guard Enabled | Whether a GuardPoint is enabled. |
