角色对象

以下内容将详细介绍有关 角色 API的相关功能。

角色

一个角色对象拥有以下属性： |属性|类型|说明| |————|—————————————————————————-|—————-| |roleid|字符串|（只读） 角色ID号。| |name
（必要）|字符串|角色名称。| |type
(必需)|整数|用户类型。

可选值：
1 - （缺省值） 普通用户；
2 - 管理员；
3 - 超级管理员。| |readonly|整数|（只读） 设定角色是否为只读。

可选值：
0 - （缺省值） 否；
1 - 是。| 注意，对于某些方法（更新、删除），必需/可选参数组合是不同的。

角色规则

角色规则拥有下列属性特征：

属性类型说明
ui数组一组包含UI元素 对象的数组。
ui.default_access整数表示新的UI元素状态为启动与否。
可配置的参数包括：

0 - 关闭；
1 - （缺省值） 开启。
services.read.mode整数只允许只读性质的业务访问。
可配置的参数包括：

0 - 启动只读模式，通过services.read.list来限定只读的业务，或者通过与services.read.tag匹配对对应业务进行访问。
1 - （缺省值） 对所有业务均采用只读访问。
services.read.list数字该数组包含所有业务 对象。
列表中的业务，包含其子业务，会对目标角色用户开启只读访问。对业务来说，只读访问并不会覆盖读写访问。
只有将services.read.mode设定为0才会开应用属性。
services.read.tag对象包含一组业务标签对象的参数。

标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。

只有将services.read.mode设定为0才会开启该功能。
services.write.mode整数对业务开启读写访问。

可配置的参数包括：

0 - （缺省值） 设定业务的读写访问，通过services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。
1 - 对所有业务开启读写访问。
services.write.list数组包含一组业务对象。

列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
services.write.tag对象包含一组业务标签对象。

标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
modules数组包含一组模块对象。
modules.default_access整数表示对新模块开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.access证书表示对API开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.mode整数对罗列在api属性中的API的方式进行模式设定。

可配置的参数包括：
0 - （缺省值） 拒绝列表；
1 - 允许列表。
api数组包含一组API的方式。
actions数组包含一组动作对象。
actions.default_access整数表示对新的动作是否开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
services.read.tag对象包含一组业务标签对象的参数。

标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。

只有将services.read.mode设定为0才会开启该功能。
services.write.mode整数对业务开启读写访问。

可配置的参数包括：

0 - （缺省值） 设定业务的读写访问，通过services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。
1 - 对所有业务开启读写访问。
services.write.list数组包含一组业务对象。

列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
services.write.tag对象包含一组业务标签对象。

标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
modules数组包含一组模块对象。
modules.default_access整数表示对新模块开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.access证书表示对API开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.mode整数对罗列在api属性中的API的方式进行模式设定。

可配置的参数包括：
0 - （缺省值） 拒绝列表；
1 - 允许列表。
api数组包含一组API的方式。
actions数组包含一组动作对象。
actions.default_access整数表示对新的动作是否开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
services.read.tag对象包含一组业务标签对象的参数。

标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。

只有将services.read.mode设定为0才会开启该功能。
services.write.mode整数对业务开启读写访问。

可配置的参数包括：

0 - （缺省值） 设定业务的读写访问，通过services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。
1 - 对所有业务开启读写访问。
services.write.list数组包含一组业务对象。

列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
services.write.tag对象包含一组业务标签对象。

标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
modules数组包含一组模块对象。
modules.default_access整数表示对新模块开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.access证书表示对API开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.mode整数对罗列在api属性中的API的方式进行模式设定。

可配置的参数包括：
0 - （缺省值） 拒绝列表；
1 - 允许列表。
api数组包含一组API的方式。
actions数组包含一组动作对象。
actions.default_access整数表示对新的动作是否开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
services.read.tag对象包含一组业务标签对象的参数。

标签所对应的业务，包含其子业务，会对目标角色用户开启对业务的只读访问。对用户来说，只读访问并不会覆盖读写访问。

只有将services.read.mode设定为0才会开启该功能。
services.write.mode整数对业务开启读写访问。

可配置的参数包括：

0 - （缺省值） 设定业务的读写访问，通过services.read.list来限定读写的业务，或者通过与services.read.tag匹配对对应业务进行访问。
1 - 对所有业务开启读写访问。
services.write.list数组包含一组业务对象。

列表中的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
services.write.tag对象包含一组业务标签对象。

标签对应的业务，包含其子业务，会对目标角色用户开启对业务的读写访问。对用户来讲，读写访问权限会覆盖只读访问权限。

只有将services.write.mode设定为0才会开启该功能。
modules数组包含一组模块对象。
modules.default_access整数表示对新模块开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.access证书表示对API开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。
api.mode整数对罗列在api属性中的API的方式进行模式设定。

可配置的参数包括：
0 - （缺省值） 拒绝列表；
1 - 允许列表。
api数组包含一组API的方式。
actions数组包含一组动作对象。
actions.default_access整数表示对新的动作是否开启访问。

可配置的参数包括：
0 - 关闭；
1 - （缺省值） 开启。

UI元素

UI元素包含下列属性对象： |属性|类型|说明| |————|—————————————————————————-|—————-| |name
(必需)|字符串|UI元素的名称。

普通用户可操作的配置数据包括：
monitoring.dashboard - 监控 → 仪表板;
monitoring.problems - 监控 → 问题；
monitoring.hosts - 监控 → 主机;
monitoring.overview - 监控 → 概览;
monitoring.latest_data - 监控 → 最新数据;
monitoring.maps - 监控 → 拓扑图;
monitoring.services - 监控 → 服务;
inventory.overview - 资产清单 → 概览;
inventory.hosts - 资产清单 → 主机;
reports.availability_report - 报告 → 可行性报告;
reports.top_triggers - 报告 → 前100触发器。

管理员和超级管理员 可操作的配置数据包括：
monitoring.discovery - 监控 → 发现;
reports.scheduled_reports - 报告 → 规划报告;
reports.notifications - 报告 → 通知;
configuration.host_groups - 配置 → 用户组;
configuration.templates - 配置 → 模板;
configuration.hosts - 配置 → 主机;
configuration.maintenance - 配置 → 维护;
configuration.actions - 配置 → 动作;
configuration.discovery - 配置 → 发现.

超级管理员 可操作的配置数据包括：
reports.system_info - 报告 → 系统信息;
reports.audit - 报告 → 审计;
reports.action_log - 报告 → 动作记录;
configuration.event_correlation - 配置 → 关联事件;
administration.general - 管理 → 通用配置;
administration.proxies - 管理 → 代理;
administration.authentication - 管理 → 授权;
administration.user_groups - 管理 → 用户组;
administration.user_roles - 管理 → 用户角色;
administration.users - 管理 → 用户;
administration.media_types - 管理 → 媒介类型;
administration.scripts - 管理 → 脚本;
administration.queue - 管理 → 队列.| |status|整数|代表是否开启UI元素的访问。

可选值：
0 - 关闭；
1 - (default) 开启。|

业务

属性类型说明
serviceid
(必要)		字符串业务ID号。

业务标签

属性类型说明
tag
(必要)		字符串标签名称。

若无填写内容，则该功能不会被使用。
value字符串标签数值。

若该属性没有填写任何参数，那么只有标签名称会被用来对应业务。

模块

模块对象拥有下列属性特征： |属性|类型|说明| |————|—————————————————————————-|—————-| |moduleid
(必要)|字符串|模块ID。| |status|整数|是否允许访问模块信息。

可配置的参数包括：
0 - 关闭；
1 - (缺省值) 开启。|

动作

动作对象拥有下列属性特征：

属性类型说明
name
(必要)		字符串动作名称。

对所有类型用户可配置的参数包括：
edit_dashboards - 创建和编辑仪表板；
edit_maps - 创建和编辑拓扑图；
add_problem_comments - 添加问题描述；
change_severity - 修改问题级别；
acknowledge_problems - 确认问题；
close_problems - 关闭问题；
execute_scripts - 运行脚本；
manage_api_tokens - 管理API令牌。

管理员 和 超级管理员 用户类型可配置的参数包括：
edit_maintenance - 创建和编辑维护；
manage_scheduled_reports - 管理规划报告。
status整数是否允许访问运行的动作信息。

可配置的参数包括：
0 - 关闭；
1 - (缺省值) 开启。