This document shows the fields supported by each provider and operation.
- get_control
- get_device
- get_personnel
- get_test
- query_controls
- query_devices
- query_evidence
- query_frameworks
- query_personnel
- query_tests
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance_control.assessment_status | ✅ | string |
| compliance_control.assessment_status_id | ✅ | number |
| compliance_control.created_time | ✅ | timestamp |
| compliance_control.desc | ✅ | string |
| compliance_control.failing_tests_count | ✅ | number |
| compliance_control.implementation_status | ✅ | string |
| compliance_control.implementation_status_id | ✅ | number |
| compliance_control.modified_time | ✅ | timestamp |
| compliance_control.name | ✅ | string |
| compliance_control.passing_tests_count | ✅ | number |
| compliance_control.standards[] | ✅ | string |
| compliance_control.uid | ✅ | string |
| compliance_control.vendor_code | ✅ | string |
| metadata.extensions[].name | ✅ | string |
| metadata.extensions[].uid | ✅ | string |
| metadata.extensions[].version | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance.checks[].name | ✅ | string |
| compliance.checks[].status | ✅ | string |
| compliance.checks[].status_id | ✅ | number |
| compliance.standards[] | ✅ | string |
| compliance.status | ✅ | string |
| compliance.status_id | ✅ | number |
| device.hostname | ✅ | string |
| device.hw_info.cpu_type | ✅ | string |
| device.hw_info.ram_size | ✅ | number |
| device.hw_info.serial_number | ✅ | string |
| device.ip | ✅ | string |
| device.last_seen_time | ✅ | timestamp |
| device.mac | ✅ | string |
| device.model | ✅ | string |
| device.name | ✅ | string |
| device.os.name | ✅ | string |
| device.os.type_id | ✅ | number |
| device.owner.name | ✅ | string |
| device.type_id | ✅ | number |
| device.uid | ✅ | string |
| device.vendor_name | ✅ | string |
| finding_info.created_time | ✅ | timestamp |
| finding_info.modified_time | ✅ | timestamp |
| finding_info.title | ✅ | string |
| finding_info.uid | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| resource.name | ✅ | string |
| resource.type | ✅ | string |
| resource.uid | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance.checks[].name | ✅ | string |
| compliance.checks[].status | ✅ | string |
| compliance.checks[].status_id | ✅ | number |
| compliance.standards[] | ✅ | string |
| compliance.status | ✅ | string |
| compliance.status_id | ✅ | number |
| finding_info.created_time | ✅ | timestamp |
| finding_info.modified_time | ✅ | timestamp |
| finding_info.title | ✅ | string |
| finding_info.uid | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| resource.name | ✅ | string |
| resource.type | ✅ | string |
| resource.uid | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance_test.assessment_status | ✅ | string |
| compliance_test.assessment_status_id | ✅ | number |
| compliance_test.category | ✅ | string |
| compliance_test.created_time | ✅ | timestamp |
| compliance_test.desc | ✅ | string |
| compliance_test.modified_time | ✅ | timestamp |
| compliance_test.name | ✅ | string |
| compliance_test.remediation.desc | ✅ | string |
| compliance_test.uid | ✅ | string |
| metadata.extensions[].name | ✅ | string |
| metadata.extensions[].uid | ✅ | string |
| metadata.extensions[].version | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance_control.assessment_status | ✅ | string |
| compliance_control.assessment_status_id | ✅ | number |
| compliance_control.created_time | ✅ | timestamp |
| compliance_control.desc | ✅ | string |
| compliance_control.failing_tests_count | ✅ | number |
| compliance_control.implementation_status | ✅ | string |
| compliance_control.implementation_status_id | ✅ | number |
| compliance_control.modified_time | ✅ | timestamp |
| compliance_control.name | ✅ | string |
| compliance_control.passing_tests_count | ✅ | number |
| compliance_control.standards[] | ✅ | string |
| compliance_control.uid | ✅ | string |
| compliance_control.vendor_code | ✅ | string |
| metadata.extensions[].name | ✅ | string |
| metadata.extensions[].uid | ✅ | string |
| metadata.extensions[].version | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance.checks[].name | ✅ | string |
| compliance.checks[].status | ✅ | string |
| compliance.checks[].status_id | ✅ | number |
| compliance.standards[] | ✅ | string |
| compliance.status | ✅ | string |
| compliance.status_id | ✅ | number |
| device.hostname | ✅ | string |
| device.hw_info.cpu_type | ✅ | string |
| device.hw_info.ram_size | ✅ | number |
| device.hw_info.serial_number | ✅ | string |
| device.ip | ✅ | string |
| device.last_seen_time | ✅ | timestamp |
| device.mac | ✅ | string |
| device.model | ✅ | string |
| device.name | ✅ | string |
| device.os.name | ✅ | string |
| device.os.type_id | ✅ | number |
| device.owner.name | ✅ | string |
| device.type_id | ✅ | number |
| device.uid | ✅ | string |
| device.vendor_name | ✅ | string |
| finding_info.created_time | ✅ | timestamp |
| finding_info.modified_time | ✅ | timestamp |
| finding_info.title | ✅ | string |
| finding_info.uid | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| resource.name | ✅ | string |
| resource.type | ✅ | string |
| resource.uid | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance_evidence.created_time | ✅ | timestamp |
| compliance_evidence.evidence_type | ✅ | string |
| compliance_evidence.evidence_type_id | ✅ | number |
| compliance_evidence.is_accepted | ✅ | boolean |
| compliance_evidence.modified_time | ✅ | timestamp |
| compliance_evidence.uid | ✅ | string |
| metadata.extensions[].name | ✅ | string |
| metadata.extensions[].uid | ✅ | string |
| metadata.extensions[].version | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance_framework.created_time | ✅ | timestamp |
| compliance_framework.desc | ✅ | string |
| compliance_framework.failing_tests_count | ✅ | number |
| compliance_framework.modified_time | ✅ | timestamp |
| compliance_framework.name | ✅ | string |
| compliance_framework.passing_tests_count | ✅ | number |
| compliance_framework.standard | ✅ | string |
| compliance_framework.total_controls_count | ✅ | number |
| compliance_framework.uid | ✅ | string |
| metadata.extensions[].name | ✅ | string |
| metadata.extensions[].uid | ✅ | string |
| metadata.extensions[].version | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance.checks[].name | ✅ | string |
| compliance.checks[].status | ✅ | string |
| compliance.checks[].status_id | ✅ | number |
| compliance.standards[] | ✅ | string |
| compliance.status | ✅ | string |
| compliance.status_id | ✅ | number |
| finding_info.created_time | ✅ | timestamp |
| finding_info.modified_time | ✅ | timestamp |
| finding_info.title | ✅ | string |
| finding_info.uid | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| resource.name | ✅ | string |
| resource.type | ✅ | string |
| resource.uid | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |
| Field | Secureframe | Type |
|---|---|---|
| activity_id | ✅ | number |
| activity_name | ✅ | string |
| category_name | ✅ | string |
| category_uid | ✅ | number |
| class_name | ✅ | string |
| class_uid | ✅ | number |
| compliance_test.assessment_status | ✅ | string |
| compliance_test.assessment_status_id | ✅ | number |
| compliance_test.category | ✅ | string |
| compliance_test.created_time | ✅ | timestamp |
| compliance_test.desc | ✅ | string |
| compliance_test.modified_time | ✅ | timestamp |
| compliance_test.name | ✅ | string |
| compliance_test.remediation.desc | ✅ | string |
| compliance_test.uid | ✅ | string |
| metadata.extensions[].name | ✅ | string |
| metadata.extensions[].uid | ✅ | string |
| metadata.extensions[].version | ✅ | string |
| metadata.product.name | ✅ | string |
| metadata.product.vendor_name | ✅ | string |
| metadata.version | ✅ | string |
| severity | ✅ | string |
| severity_id | ✅ | number |
| time | ✅ | number |
| type_name | ✅ | string |
| type_uid | ✅ | number |