Skip to main content

AdminRole Schema

Data structure for Admin Role objects.

Fields​

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

Example​

{
"id": 123,
"rank": 123,
"name": "string",
"policy_access": "string",
"alerting_access": "string",
"dashboard_access": "string",
"report_access": "string",
"analysis_access": "string"
}
// ... more fields