Objeto role

Os seguintes objetos estão diretamente relacionados à API role.

Role

O objeto role possui as seguintes propriedades:

Propriedade Tipo Descrição
roleid ID ID da role.

Comportamento da propriedade:
- somente leitura
- obrigatório para operações de atualização
name string Nome da role.

Comportamento da propriedade:
- obrigatório para operações de criação
type integer Tipo de usuário.

Valores possíveis:
1 - (padrão) Usuário;
2 - Admin;
3 - Super admin.

Comportamento da propriedade:
- obrigatório para operações de criação
readonly integer Se a role é somente leitura.

Valores possíveis:
0 - (padrão) Não;
1 - Sim.

Comportamento da propriedade:
- somente leitura

Regras de função

O objeto de regras de função possui as seguintes propriedades:

Propriedade Tipo Descrição
ui array Array de objetos de elemento da interface.
ui.default_access integer Se o acesso a novos elementos da interface está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.
services.read.mode integer Acesso somente leitura aos serviços.

Valores possíveis:
0 - Acesso somente leitura aos serviços especificados pela propriedade services.read.list ou correspondentes pela propriedade services.read.tag;
1 - (padrão) Acesso somente leitura a todos os serviços.
services.read.list array Array de objetos de Serviço.

Os serviços especificados, incluindo serviços filhos, terão acesso somente leitura concedido à função de usuário. O acesso somente leitura não substituirá o acesso de leitura e gravação aos serviços.

Comportamento da propriedade:
- suportado se services.read.mode estiver definido como "0"
services.read.tag object Array de objetos de Tag de serviço.

Os serviços correspondentes à tag, incluindo serviços filhos, terão acesso somente leitura concedido à função de usuário. O acesso somente leitura não substituirá o acesso de leitura e gravação aos serviços.

Comportamento da propriedade:
- suportado se services.read.mode estiver definido como "0"
services.write.mode integer Acesso de leitura e gravação aos serviços.

Valores possíveis:
0 - (padrão) Acesso de leitura e gravação aos serviços especificados pela propriedade services.write.list ou correspondentes pela propriedade services.write.tag;
1 - Acesso de leitura e gravação a todos os serviços.
services.write.list array Array de objetos de Serviço.

Os serviços especificados, incluindo serviços filhos, terão acesso de leitura e gravação concedido à função de usuário. O acesso de leitura e gravação substituirá o acesso somente leitura aos serviços.

Comportamento da propriedade:
- suportado se services.write.mode estiver definido como "0"
services.write.tag object Array de objetos de Tag de serviço.

Os serviços correspondentes à tag, incluindo serviços filhos, terão acesso de leitura e gravação concedido à função de usuário. O acesso de leitura e gravação substituirá o acesso somente leitura aos serviços.

Comportamento da propriedade:
- suportado se services.write.mode estiver definido como "0"
modules array Array de objetos de módulo.
modules.default_access integer Se o acesso a novos módulos está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.
api.access integer Se o acesso à API está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.
api.mode integer Modo de tratamento dos métodos da API listados na propriedade api.

Valores possíveis:
0 - (padrão) Lista de negação;
1 - Lista de permissão.
api array Array de métodos da API.
actions array Array de objetos de ação.
actions.default_access integer Se o acesso a novas ações está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.

Elemento de UI

O objeto UI element possui as seguintes propriedades:

Property Type Description
name string Nome do elemento de UI.

Valores possíveis se o type do objeto Role estiver definido como "User", "Admin" ou "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 possíveis se o type do objeto Role estiver definido como "Admin" ou "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 possíveis se o type do objeto Role estiver definido como "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.

Property behavior:
- required
status integer Se o acesso ao elemento de UI está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.

Serviço

Propriedade Tipo Descrição
serviceid ID ID do Serviço.

Comportamento da propriedade:
- obrigatório

Tag de serviço

Propriedade Tipo Descrição
tag string Nome da tag.

Se uma string vazia for especificada, a tag de serviço não será usada para correspondência de serviço.

Comportamento da propriedade:
- obrigatório
value string Valor da tag.

Se nenhum valor ou uma string vazia for especificada, apenas o nome da tag será usado para correspondência de serviço.

Módulo

O objeto módulo possui as seguintes propriedades:

Propriedade Tipo Descrição
moduleid ID ID do módulo.

Comportamento da propriedade:
- obrigatório
status integer Se o acesso ao módulo está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.

Ação

O objeto action possui as seguintes propriedades:

Propriedade Tipo Descrição
name string Nome da ação.

Valores possíveis se o type do objeto Role estiver definido como "User", "Admin" ou "Super admin:
edit_dashboards - Criar e editar dashboards;
edit_maps - Criar e editar mapas;
add_problem_comments - Adicionar comentários de problema;
change_severity - Alterar a severidade do problema;
acknowledge_problems - Reconhecer problemas;
suppress_problems - Suprimir problemas;
close_problems - Fechar problemas;
execute_scripts - Executar scripts;
manage_api_tokens - Gerenciar tokens de API;
change_problem_ranking - Alterar a classificação do problema de causa para sintoma e vice-versa;
edit_own_media - Permitir criar/editar sua própria mídia.

Valores possíveis se o type do objeto Role estiver definido como "Admin" ou "Super admin":
edit_maintenance - Criar e editar manutenções;
manage_scheduled_reports - Gerenciar relatórios agendados,
manage_sla - Gerenciar SLA.

Valores possíveis se o type do objeto Role estiver definido como "User" ou "Admin":
invoke_execute_now - permite executar verificações de item para usuários que possuem apenas permissões de leitura no host.

Valores possíveis se o type do objeto Role estiver definido como "Super admin":
edit_user_media - Permitir criar/editar mídia para usuários.

Comportamento da propriedade:
- obrigatório
status integer Se o acesso para executar a ação está habilitado.

Valores possíveis:
0 - Desabilitado;
1 - (padrão) Habilitado.