Objeto role

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

Função

O objeto função possui as seguintes propriedades:

Propriedade	Tipo	Descrição
roleid	ID	ID da função. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização
name	string	Nome da função. 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 função é 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 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 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 escrita aos serviços. Comportamento da propriedade: - suportado se `services.read.mode` estiver definido como "0"
services.read.tag	object	Array de objetos 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 escrita aos serviços. Comportamento da propriedade: - suportado se `services.read.mode` estiver definido como "0"
services.write.mode	integer	Acesso de leitura e escrita aos serviços. Valores possíveis: 0 - (padrão) Acesso de leitura e escrita aos serviços especificados pela propriedade `services.write.list` ou correspondentes pela propriedade `services.write.tag`; 1 - Acesso de leitura e escrita a todos os serviços.
services.write.list	array	Array de objetos Serviço. Os serviços especificados, incluindo serviços filhos, terão acesso de leitura e escrita concedido à função de usuário. O acesso de leitura e escrita 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 Tag de serviço. Os serviços correspondentes à tag, incluindo serviços filhos, terão acesso de leitura e escrita concedido à função de usuário. O acesso de leitura e escrita 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 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 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 da interface

O objeto de elemento da interface possui as seguintes propriedades:

Propriedade	Tipo	Descrição
name	string	Nome do elemento da interface. Valores possíveis se o `type` do objeto Role estiver definido como "User", "Admin" ou "Super admin": `monitoring.dashboard` - Dashboards; `monitoring.problems` - Monitoramento → Problemas; `monitoring.hosts` - Monitoramento → Hosts; `monitoring.latest_data` - Monitoramento → Últimos dados; `monitoring.maps` - Monitoramento → Mapas; `services.services` - Serviços → Serviços; `services.sla_report` - Serviços → Relatório de SLA; `inventory.overview` - Inventário → Visão geral; `inventory.hosts` - Inventário → Hosts; `reports.availability_report` - Relatórios → Relatório de disponibilidade; `reports.top_triggers` - Relatórios → Top 100 triggers. Valores possíveis se o `type` do objeto Role estiver definido como "Admin" ou "Super admin": `monitoring.discovery` - Monitoramento → Descoberta; `services.sla` - Serviços → SLA; `reports.scheduled_reports` - Relatórios → Relatórios agendados; `reports.notifications` - Relatórios → Notificações; `configuration.template_groups` - Coleta de dados → Grupos de templates; `configuration.host_groups` - Coleta de dados → Grupos de hosts; `configuration.templates` - Coleta de dados → Templates; `configuration.hosts` - Coleta de dados → Hosts; `configuration.maintenance` - Coleta de dados → Manutenção; `configuration.discovery` - Coleta de dados → Descoberta; `configuration.trigger_actions` - Alertas → Ações → Ações de trigger; `configuration.service_actions` - Alertas → Ações → Ações de serviço; `configuration.discovery_actions` - Alertas → Ações → Ações de descoberta; `configuration.autoregistration_actions` - Alertas → Ações → Ações de auto-registro; `configuration.internal_actions` - Alertas → Ações → Ações internas. Valores possíveis se o `type` do objeto Role estiver definido como "Super admin": `reports.system_info` - Relatórios → Informações do sistema; `reports.audit` - Relatórios → Log de auditoria; `reports.action_log` - Relatórios → Log de ações; `configuration.event_correlation` - Coleta de dados → Correlação de eventos; `administration.media_types` - Alertas → Tipos de mídia; `administration.scripts` - Alertas → Scripts; `administration.user_groups` - Usuários → Grupos de usuários; `administration.user_roles` - Usuários → Funções de usuário; `administration.users` - Usuários → Usuários; `administration.api_tokens` - Usuários → Tokens de API; `administration.authentication` - Usuários → Autenticação; `administration.general` - Administração → Geral; `administration.audit_log` - Administração → Log de auditoria; `administration.housekeeping` - Administração → Limpeza; `administration.proxy_groups` - Administração → Grupos de proxy; `administration.proxies` - Administração → Proxies; `administration.macros` - Administração → Macros; `administration.queue` - Administração → Fila. Comportamento da propriedade: - obrigatório
status	integer	Se o acesso ao elemento da interface está habilitado. Valores possíveis: 0 - Desabilitado; 1 - (padrão) Habilitado.

Service

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; `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.

Documentation