Skip to main content

AdminRole Schema

Data structure for Admin Role objects.

Fields​

FieldTypeRequiredDescriptionNotes
admin_acct_accessstringNo-API field: admin_acct_access
alerting_accessstringNo-API field: alerting_access
analysis_accessstringNo-API field: analysis_access
dashboard_accessstringNo-API field: dashboard_access
device_info_accessstringNo-API field: device_info_access
ext_feature_permissionsExtFeaturePermissionsEnumRecordNo-API field: ext_feature_permissions
feature_permissionsAccessControlEnumRecordNo-API field: feature_permissions
idintegerYes--
is_auditorbooleanNo-API field: is_auditor
is_non_editablebooleanNo-API field: is_non_editable
logs_limitstringNo-API field: logs_limit
namestringYes--
permissionsPermissionsEnumCollectionNo--
policy_accessstringNo-API field: policy_access
rankintegerNo--
report_accessstringNo-API field: report_access
report_time_durationintegerNo-API field: report_time_duration
role_typestringNo-API field: role_type
username_accessstringNo-API field: username_access

Example​

{
"admin_acct_access": "string",
"alerting_access": "string",
"analysis_access": "string",
"dashboard_access": "string",
"device_info_access": "string",
"ext_feature_permissions": {
"id": "object-id"
},
"feature_permissions": {
"id": "object-id"
},
"id": 123
}
// ... more fields