[comment]: # translation:outdated

[comment]: # ({2135842b-2135842b})
# > Objeto de rol

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

[comment]: # ({/2135842b-2135842b})

[comment]: # ({84ee8c53-1708e020})
### Rol

El objeto de rol tiene las siguientes propiedades:

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|roleid|cadena|*(readonly)* ID del rol.|
|**name**<br>(obligatorio)|cadena|Nombre del rol.|
|**type**<br>(obligatorio)|entero|Tipo de usuario.<br><br>Valores posibles:<br>1 - *(predeterminado)* Usuario;<br>2 - Administrador;<br>3 - Súper administrador.|
|readonly|entero|*(readonly)* Si el rol es de solo lectura.<br><br>Valores posibles:<br>0 - *(predeterminado)* No;<br>1 - Sí.|

Tenga en cuenta que para algunos métodos (actualizar, eliminar) la combinación de parámetros requeridos/opcionales es diferente.

[comment]: # ({/84ee8c53-1708e020})

[comment]: # ({672ddb55-8a9b3008})
### Reglas de rol

El objeto de reglas de rol tiene las siguientes propiedades:

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|ui|array|Matriz de los objetos [elemento UI](object#ui_element).|
|ui.default\_access|integer|Si el acceso a nuevos elementos de la interfaz de usuario está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|
|services.read.mode|integer|Acceso de solo lectura a los servicios.<br><br>Valores posibles:<br><br>0 - Acceso de solo lectura a los servicios, especificado por `services.read.list ` o coincide con las propiedades `services.read.tag`.<br>1 - *(predeterminado)* Acceso de solo lectura a todos los servicios.|
|services.read.list|array|Matriz de objetos [Servicio](objeto#servicio).<br><br>A los servicios especificados, incluidos los servicios secundarios, se les otorgará acceso de solo lectura al rol de usuario. El acceso de solo lectura no anulará el acceso de lectura y escritura a los servicios.<br><br>Solo se usa si `services.read.mode` está establecido en 0.|
|services.read.tag|object|Matriz de objeto [etiqueta de servicio](object#service_tag).<br><br>A los servicios coincidentes con etiquetas, incluidos los servicios secundarios, se les otorgará acceso de solo lectura al rol de usuario. El acceso de solo lectura no anulará el acceso de lectura y escritura a los servicios.<br><br>Solo se usa si `services.read.mode` está establecido en 0.|
|services.write.mode|entero|Acceso de lectura y escritura a los servicios.<br><br>Valores posibles:<br><br>0 - (predeterminado) Acceso de lectura y escritura a los servicios, especificado por `servicios. write.list` o coincide con las propiedades `services.write.tag`.<br>1 - Acceso de lectura y escritura a todos los servicios.|
|services.write.list|array|Matriz de objetos [Servicio](objeto#servicio).<br><br>A los servicios especificados, incluidos los servicios secundarios, se les otorgará acceso de lectura y escritura al rol de usuario. El acceso de lectura y escritura anulará el acceso de solo lectura a los servicios.<br><br>Solo se usa si `services.write.mode` está establecido en 0.|
|services.write.tag|object|Matriz de objeto [etiqueta de servicio](object#service_tag).<br><br>A los servicios coincidentes con etiquetas, incluidos los servicios secundarios, se les otorgará acceso de lectura y escritura al rol de usuario. El acceso de lectura y escritura anulará el acceso de solo lectura a los servicios.<br><br>Solo se usa si `services.write.mode` está establecido en 0.|
|módulos|matriz|Matriz de los objetos [módulo](objeto#módulo).|
|modules.default\_access|integer|Si el acceso a nuevos módulos está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|
|api.access|integer|Si el acceso a la API está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|
|api.mode|integer|Modo para tratar los métodos API enumerados en la propiedad `api`.<br><br>Valores posibles:<br>0 - *(predeterminado)* Lista de denegados;<br>1 - Lista de permitidos. |
|api|array|Matriz de métodos API.|
|acciones|array|Matriz de los objetos [acción](objeto#acción).|
|actions.default\_access|integer|Si el acceso a nuevas acciones está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|

[comment]: # ({/672ddb55-8a9b3008})

[comment]: # ({6e1ef027-006cdfb5})
### elemento de interfaz de usuario

El objeto del elemento UI tiene las siguientes propiedades:

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|**nombre**<br>(obligatorio)|cadena|Nombre del elemento de la interfaz de usuario.<br><br>Valores posibles para usuarios de cualquier tipo:<br>`monitoring.dashboard` - *Monitoring → Dashboard*; <br>`monitoring.problems` - *Monitoring → Problemas*;<br>`monitoring.hosts` - *Monitoring → Hosts*;<br>`monitoring.latest_data` - *Monitoring → Últimos datos*;<br>` Monitoring.maps` - *Monitoreo → Mapas*;<br>`services.services` - *Servicios → Servicios*;<br>`services.sla_report` - *Servicios → Informe SLA*;<br>`inventory.overview` - *Inventario → Descripción general*;<br>`inventory.hosts` - *Inventario → Hosts*;<br>`reports.availability_report` - *Informes → Informe de disponibilidad*;<br>`reports.top_triggers` - *Informes → Activa el top 100*.<br><br>Valores posibles solo para usuarios de los tipos de usuario *Admin* y *Super admin*:<br>`monitoring.discovery` - *Monitoring → Discovery*;<br>`services.actions ` - *Servicios → Acciones de servicio*;<br>`services.sla` - *Servicios → SLA*;<br>`reports.scheduled_reports` - *Informes → Informes programados*;<br>`reports.notifications` - * Informes → Notificaciones*;<br>`configuration.host_groups` - *Configuración → Grupos de hosts*;<br>`configuration.templates` - *Configuración → Plantillas*;<br>`configuration.hosts` - *Configuración → Hosts* ;<br>`configuration.maintenance` - *Configuración → Mantenimiento*;<br>`configuration.actions` - *Configuración → Acciones*;<br>`configuration.discovery` - *Configuración → Descubrimiento*.<br>< br>Valores posibles solo para usuarios del tipo de usuario *Super admin*:<br>`reports.system_info` - *Reports → Información del sistema*;<br>`reports.audit` - *Reports → Audit*;<br>` reports.action_log` - *Informes → Registro de acciones*;<br>`configuration.event_correlation` - *Configuración → Correlación de eventos*;<br>`administration.general` - *Administración → General*;<br>`administration.proxies ` - *Administración → Proxies*;<br>`administration.authentication` - *Administración → Autenticación*;<br>`administration.user_groups` - *Administración → Grupos de usuarios*;<br>`administration.user_roles` - *Administración → Roles de usuario*;<br>`administration.users` - *Administración → Usuarios*;<br>`administration.media_types` - *Administración → Tipos de medios*;<br>`administration.scripts` - *Administración → Scripts* ;<br>`administración.cola` - *Administración → Cola*.|
|status|integer|Si el acceso al elemento de la interfaz de usuario está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|

[comment]: # ({/6e1ef027-006cdfb5})

[comment]: # ({1ef3faf9-ebf4bb3a})
### Servicio

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|**serviceid**<br>(obligatorio)|cadena|ID del Servicio.|

[comment]: # ({/1ef3faf9-ebf4bb3a})

[comment]: # ({54254705-300e6d5b})
### Etiqueta de servicio

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|**tag**<br>(obligatorio)|cadena|Nombre de etiqueta.<br><br>Si se especifica una cadena vacía, la etiqueta de servicio no se utilizará para la coincidencia de servicios.|
|value|cadena|Valor de etiqueta.<br><br>Si no se especifica ningún valor o una cadena vacía, solo se utilizará el nombre de la etiqueta para la coincidencia del servicio.|

[comment]: # ({/54254705-300e6d5b})

[comment]: # ({7dead620-f70e75e9})
### Módulo

El objeto module tiene las siguientes propiedades:

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|**moduleid**<br>(obligatorio)|cadena|ID del módulo.|
|status|entero|Si el acceso al módulo está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|

[comment]: # ({/7dead620-f70e75e9})

[comment]: # ({fda66d22-957a00bb})
### Acción

El objeto action tiene las siguientes propiedades:

|Propiedad|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|**name**<br>(obligatorio)|cadena|Nombre de la acción.<br><br>Valores posibles para usuarios de cualquier tipo:<br>`edit_dashboards` - Crear y editar tableros;<br>` edit_maps` - Crear y editar mapas;<br>`add_problem_comments` - Agregar comentarios de problemas;<br>`change_severity` - Cambiar la gravedad del problema;<br>`acknowledge_problems` - Reconocer problemas;<br>`close_problems` - Cerrar problemas; <br>`execute_scripts` - Ejecutar scripts;<br>`manage_api_tokens` - Administrar tokens API.<br><br>Valores posibles solo para usuarios de los tipos de usuario *Admin* y *Super admin*:<br>`edit_maintenance` - Crear y editar mantenimientos;<br>`manage_scheduled_reports` - Administrar informes programados;<br>`manage_sla` - Administrar SLA.|
|status|entero|Si el acceso para realizar la acción está habilitado.<br><br>Valores posibles:<br>0 - Deshabilitado;<br>1 - *(predeterminado)* Habilitado.|

[comment]: # ({/fda66d22-957a00bb})
