Objeto de rol

Los siguientes objetos están directamente relacionados con la API de role.

Rol

El objeto rol tiene las siguientes propiedades:

Propiedad Tipo Descripción
roleid ID ID del rol.

Comportamiento de la propiedad:
- solo lectura
- requerido para operaciones de actualización
name string Nombre del rol.

Comportamiento de la propiedad:
- requerido para operaciones de creación
type integer Tipo de usuario.

Valores posibles:
1 - (por defecto) Usuario;
2 - Admin;
3 - Super admin.

Comportamiento de la propiedad:
- requerido para operaciones de creación
readonly integer Si el rol es de solo lectura.

Valores posibles:
0 - (por defecto) No;
1 - Sí.

Comportamiento de la propiedad:
- solo lectura

Reglas de roles

El objeto de reglas de roles tiene las siguientes propiedades:

Propiedad Tipo Descripción
ui array Array de objetos de elemento de UI.
ui.default_access integer Indica si el acceso a los nuevos elementos de la UI está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.
services.read.mode integer Acceso de solo lectura a los servicios.

Valores posibles:
0 - Acceso de solo lectura a los servicios especificados por las propiedades services.read.list o coincidentes por services.read.tag;
1 - (por defecto) Acceso de solo lectura a todos los servicios.
services.read.list array Array de objetos Service.

Los servicios especificados, incluidos los servicios secundarios, tendrán acceso de solo lectura para el rol de usuario. El acceso de solo lectura no anulará el acceso de lectura-escritura a los servicios.

Comportamiento de la propiedad:
- soportado si services.read.mode está establecido en "0"
services.read.tag object Array de objetos Service tag.

Los servicios coincidentes por etiqueta, incluidos los servicios secundarios, tendrán acceso de solo lectura para el rol de usuario. El acceso de solo lectura no anulará el acceso de lectura-escritura a los servicios.

Comportamiento de la propiedad:
- soportado si services.read.mode está establecido en "0"
services.write.mode integer Acceso de lectura-escritura a los servicios.

Valores posibles:
0 - (por defecto) Acceso de lectura-escritura a los servicios especificados por las propiedades services.write.list o coincidentes por services.write.tag;
1 - Acceso de lectura-escritura a todos los servicios.
services.write.list array Array de objetos Service.

Los servicios especificados, incluidos los servicios secundarios, tendrán acceso de lectura-escritura para el rol de usuario. El acceso de lectura-escritura anulará el acceso de solo lectura a los servicios.

Comportamiento de la propiedad:
- soportado si services.write.mode está establecido en "0"
services.write.tag object Array de objetos Service tag.

Los servicios coincidentes por etiqueta, incluidos los servicios secundarios, tendrán acceso de lectura-escritura para el rol de usuario. El acceso de lectura-escritura anulará el acceso de solo lectura a los servicios.

Comportamiento de la propiedad:
- soportado si services.write.mode está establecido en "0"
modules array Array de objetos de módulo.
modules.default_access integer Indica si el acceso a los nuevos módulos está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.
api.access integer Indica si el acceso a la API está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.
api.mode integer Modo para tratar los métodos de la API listados en la propiedad api.

Valores posibles:
0 - (por defecto) Lista de denegación;
1 - Lista de permitidos.
api array Array de métodos de la API.
actions array Array de objetos de acción.
actions.default_access integer Indica si el acceso a las nuevas acciones está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.

Elemento de la interfaz de usuario

El objeto de elemento de la interfaz de usuario tiene las siguientes propiedades:

Propiedad Tipo Descripción
name string Nombre del elemento de la interfaz de usuario.

Valores posibles si el type del objeto Role está establecido en "User", "Admin" o "Super admin":
monitoring.dashboard - Dashboards;
monitoring.problems - Monitoring → Problems;
monitoring.hosts - Monitoring → Hosts;
monitoring.latest_data - Monitoring → Latest data;
monitoring.maps - Monitoring → Maps;
services.services - Services → Services;
services.sla_report - Services → SLA report;
inventory.overview - Inventory → Overview;
inventory.hosts - Inventory → Hosts;
reports.availability_report - Reports → Availability report;
reports.top_triggers - Reports → Triggers top 100.

Valores posibles si el type del objeto Role está establecido en "Admin" o "Super admin":
monitoring.discovery - Monitoring → Discovery;
services.sla - Services → SLA;
reports.scheduled_reports - Reports → Scheduled reports;
reports.notifications - Reports → Notifications;
configuration.template_groups - Data collection → Template groups;
configuration.host_groups - Data collection → Host groups;
configuration.templates - Data collection → Templates;
configuration.hosts - Data collection → Hosts;
configuration.maintenance - Data collection → Maintenance;
configuration.discovery - Data collection → Discovery;
configuration.trigger_actions - Alerts → Actions → Trigger actions;
configuration.service_actions - Alerts → Actions → Service actions;
configuration.discovery_actions - Alerts → Actions → Discovery actions;
configuration.autoregistration_actions - Alerts → Actions → Autoregistration actions;
configuration.internal_actions - Alerts → Actions → Internal actions.

Valores posibles si el type del objeto Role está establecido en "Super admin":
reports.system_info - Reports → System information;
reports.audit - Reports → Audit log;
reports.action_log - Reports → Action log;
configuration.event_correlation - Data collection → Event correlation;
administration.media_types - Alerts → Media types;
administration.scripts - Alerts → Scripts;
administration.user_groups - Users → User groups;
administration.user_roles - Users → User roles;
administration.users - Users → Users;
administration.api_tokens - Users → API tokens;
administration.authentication - Users → Authentication;
administration.general - Administration → General;
administration.audit_log - Administration → Audit log;
administration.housekeeping - Administration → Housekeeping;
administration.proxy_groups - Administration → Proxy groups;
administration.proxies - Administration → Proxies;
administration.macros - Administration → Macros;
administration.queue - Administration → Queue.

Comportamiento de la propiedad:
- requerido
status integer Indica si el acceso al elemento de la interfaz de usuario está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.

Servicio

Propiedad Tipo Descripción
serviceid ID ID del servicio.

Comportamiento de la propiedad:
- requerido

Etiqueta de servicio

Propiedad Tipo Descripción
tag string Nombre de la etiqueta.

Si se especifica una cadena vacía, la etiqueta de servicio no se utilizará para la coincidencia de servicios.

Comportamiento de la propiedad:
- obligatorio
value string Valor de la etiqueta.

Si no se especifica ningún valor o una cadena vacía, sólo se utilizará el nombre de la etiqueta para la coincidencia de servicios.

Módulo

El objeto módulo tiene las siguientes propiedades:

Propiedad Tipo Descripción
moduleid ID ID del módulo.

Comportamiento de la propiedad:
- requerido
status integer Si el acceso al módulo está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.

Acción

El objeto acción tiene las siguientes propiedades:

Propiedad Tipo Descripción
name string Nombre de la acción.

Valores posibles si el type del objeto Role está establecido en "User", "Admin" o "Super admin:
edit_dashboards - Crear y editar dashboards;
edit_maps - Crear y editar mapas;
add_problem_comments - Añadir comentarios a los problemas;
change_severity - Cambiar la gravedad del problema;
acknowledge_problems - Reconocer problemas;
suppress_problems - Suprimir problemas;
close_problems - Cerrar problemas;
execute_scripts - Ejecutar scripts;
manage_api_tokens - Gestionar tokens de API;
change_problem_ranking - Cambiar la clasificación del problema de causa a síntoma y viceversa;
edit_own_media - Permitir crear/editar medios propios.

Valores posibles si el type del objeto Role está establecido en "Admin" o "Super admin":
edit_maintenance - Crear y editar mantenimientos;
manage_scheduled_reports - Gestionar informes programados,
manage_sla - Gestionar SLA.

Valores posibles si el type del objeto Role está establecido en "User" o "Admin":
invoke_execute_now - permite ejecutar comprobaciones de item para usuarios que solo tienen permisos de lectura en el host.

Valores posibles si el type del objeto Role está establecido en "Super admin":
edit_user_media - Permitir crear/editar medios para los usuarios.

Comportamiento de la propiedad:
- requerido
status integer Indica si el acceso para realizar la acción está habilitado.

Valores posibles:
0 - Deshabilitado;
1 - (por defecto) Habilitado.