Policies Keys Report
The Policies Keys Report shows the list of keys used by the CTE policies. A key can be used by multiple policies, similarly, a policy can have multiple keys.
Generating the Report
Use the get /v1/transparent-encryption/reports/policies-keys 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/policies-keys/?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 |
|---|---|---|
| policy_name | string | (optional) Name of the policy on the CipherTrust Manager. If not specified, the report will contain all policies. |
| 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. |
| key_name | string | (optional) Name of the key. If not specified, the report will contain all keys used by the specified policies. |
| 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/policies-keys/?sort=policy_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 3,
"resources": [
{
"policy_name": "hr_policy",
"policy_type": "STANDARD",
"key_name": "hr_key",
},
{
"policy_name": "it_policy",
"policy_type": "IDT",
"key_name": "it_key",
},
{
"policy_name": "test_policy",
"policy_type": "LDT",
"key_name": "test_key",
}
]
}
The output shows the mapping of clients with their respective profiles on the CipherTrust Manager. 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.
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/policies-keys/download/?report_type=pdf&sort=policy_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_policies_keys_<TIMESTAMP>.csv, for example, cte_policies_keys_2021-01-12T07_11_57Z.csv.
If you specified report_type as pdf, the report is downloaded in a PDF document named, cte_policies_keys_<TIMESTAMP>.pdf, for example, cte_policies_keys_2021-01-12T07_13_23Z.pdf.
The downloaded PDF document shows the Report Name as Policies Keys 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 |
|---|---|
| Policy Name | Name of the policy. |
| Policy Type | Type of the policy. |
| Key Name | Key used by the policy. |
