[comment]: # translation:outdated [comment]: # ({2135842b-2135842b}) # > Objeto de função Os objetos a seguir estão diretamente relacionados à API `role`. [comment]: # ({/2135842b-2135842b}) [comment]: # ({f3146639-1708e020}) ### Função O objeto role tem as seguintes propriedades: |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |roleid|string|*(somente leitura)* ID da função.| |**name**
(requerido)|string|Nome da role.| |**type**
(requerido)|integer|Tipo de usuário.

Valores possíveis:
1 - *(padrão)* Usuário;
2 - Admin;
3 - Super admin.| |readonly|integer|*(somente leitura)* Se a função é somente leitura.

Valores possíveis:
0 - *(padrão)* Não;
1 - Sim.| [comment]: # ({/f3146639-1708e020}) [comment]: # ({efbe0de9-8a9b3008}) ### Regras de função O objeto de regras de função tem as seguintes propriedades: |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |ui|array|Array dos objetos [elemento da interface do usuário](object#ui_element.| |ui.default\_access|integer|Se o acesso a novos elementos da interface do usuário está ativado.

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

Valores possíveis:

0 - Acesso somente leitura aos serviços, especificado pelo `services.read.list` ou correspondido pelo `services.read Propriedades .tag`.
1 - *(padrão)* Acesso somente leitura a todos os serviços.| |services.read.list|array|Array de objetos [Serviço](object#service).

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

Usado somente se `services.read.mode` estiver definido como 0.| |services.read.tag|object|Array do objeto [Tag de serviço](object#service_tag).

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

Usado somente se `services.read.mode` for 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 pelo `services.write.list` ou correspondidos pelo ` services.write.tag`.
1 - Acesso de leitura e gravação a todos os serviços.| |services.write.list|array|Array de objetos [Serviço](object#service).

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

Usado somente se `services.write.mode` for definido como 0.| |services.write.tag|object|Array do objeto [Tag de serviço](object#service_tag).

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

Usado somente se `services.write.mode` for definido como 0.| |modules|array|Array dos objetos [módulo](object#module).| |modules.default\_access|integer|Se o acesso a novos módulos está ativado.

Valores possíveis:
0 - Desativado;
1 - *(padrão)* Ativado.| |api.access|integer|Se o acesso à API está ativado.

Valores possíveis:
0 - Desativado;
1 - *(padrão)* Ativado.| |api.mode|integer|Modo de tratamento de métodos de API listados na propriedade `api`.

Valores possíveis:
0 - *(padrão)* Lista de negações;
1 - Lista de permissões.| |api|array|Array de métodos de API.| |actions|array|Array dos objetos [ação](object#action).| |actions.default\_access|integer|Se o acesso a novas ações está ativado.

Valores possíveis:
0 - Desativado;
1 - *(padrão)* Ativado.| [comment]: # ({/efbe0de9-8a9b3008}) [comment]: # ({dc2e18fc-006cdfb5}) ### Elemento de IU O objeto de elemento de interface do usuário (UI) tem as seguintes propriedades: |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |**name**
(requerido)|string|Nome do elemento da interface do usuário.

Valores possíveis para usuários de qualquer tipo:
`monitoring.dashboard` - *Monitoramento → Dashboard*;
`monitoring.problems` - *Monitoramento → Problemas*;
`monitoring.hosts` - *Monitoramento → Hosts*;
`monitoring.overview` - *Monitoramento → Visão geral*;
`monitoring.latest_data` - *Monitoramento → Dados recentes*;
`monitoring.maps` - *Monitoramento → Mapas*;
`monitoring.services` - *Monitoramento → Serviços*;
`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 → Triggers top 100*.

Valores possíveis apenas para usuários dos tipos de usuário *Admin* e *Super admin*:
`monitoring.discovery` - *Monitoramento → Descoberta*;
`reports.scheduled_reports` - *Relatórios → Relatórios programados*;
`reports.notifications` - *Relatórios → Notificações*;
`configuration.host_groups` - *Configuração → Grupos de hosts*;
`configuration.templates` - *Configuração → Templates*;
`configuration.hosts` - *Configuração → Hosts*;
`configuration.maintenance` - *Configuração → Manutenção*;
`configuration.actions` - *Configuração → Ações*;
`configuration.discovery` - *Configuração → Descoberta*.

Valores possíveis apenas para usuários do tipo de usuário *Super admin*:
`reports.system_info` - *Relatórios → Informação do sistema*;
`reports.audit` - *Relatórios → Auditoria*;
`reports.action_log` - *Relatórios → Log de ações*;
`configuration.event_correlation` - *Configuration → Correlação de eventos*;
`administration.general` - *Administração → Geral*;
`administration.proxies` - *Administração → Proxies*;
`administration.authentication` - *Administração → Autenticação*;
`administration.user_groups` - *Administração → User groups*;
`administration.user_roles` - *Administração → Funções do usuário*;
`administration.users` - *Administração → Usuários*;
`administration.media_types` - *Administração → Tipos de mídia*;
`administration.scripts` - *Administration → Scripts*;
`administration.queue` - *Administração → Fila*.| |status|integer|Se o acesso ao elemento da interface do usuário está ativado.

Valores possíveis:
0 - Desativado;
1 - *(padrão)* Ativado.| [comment]: # ({/dc2e18fc-006cdfb5}) [comment]: # ({9cf8a30e-ebf4bb3a}) ### Serviço |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |**serviceid**
(requerido)|string|ID do serviço.| [comment]: # ({/9cf8a30e-ebf4bb3a}) [comment]: # ({33347479-300e6d5b}) ### Etiqueta de serviço |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |**tag**
(requerido)|string|Nome da etiqueta.

Se uma string vazia for especificada, a etiqueta de serviço não será usada para correspondência de serviço.| |value|string|Valor da etiqueta.

Se nenhum valor ou string vazia for especificado, apenas o nome da etiqueta será usado para correspondência de serviço.| [comment]: # ({/33347479-300e6d5b}) [comment]: # ({027f7b1a-f70e75e9}) ### Módulo O objeto módulo tem as seguintes propriedades: |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |**moduleid**
(requerido)|string|ID do módulo.| |status|integer|Se o acesso ao módulo está ativado.

Valores possíveis:
0 - Desativado;
1 - *(padrão)* Ativado.| [comment]: # ({/027f7b1a-f70e75e9}) [comment]: # ({39af357c-957a00bb}) ### Ação O objeto de ação tem as seguintes propriedades: |Propriedade|[Tipo](/manual/api/reference_commentary#data_types)|Descrição| |--|--|------| |**name**
(requerido)|string|Nome da ação.

Valores possíveis para usuários de qualquer tipo:
`edit_dashboards` - Criar e editar dashboards;
`edit_maps` - Criar e editar mapas;
`add_problem_comments` - Adicionar comentários do problema;
`change_severity` - Alterar a gravidade do problema;
`acknowledge_problems` - Reconhecer problemas;
`close_problems` - Fechar problemas;
`execute_scripts` - Executar scripts;
`manage_api_tokens` - Gerenciar tokens de API.

Valores possíveis apenas para usuários dos tipos de usuário *Admin* e *Super admin*:
`edit_maintenance` - Criar e editar manutenções;< br>`manage_scheduled_reports` - Gerenciar relatórios programados.| |status|integer|Se o acesso para realizar a ação está ativado.

Valores possíveis:
0 - Desativado;
1 - *(padrão)* Ativado.| [comment]: # ({/39af357c-957a00bb})