[comment]: # translation:outdated
[comment]: # ({2135842b-2135842b})
# > Objecte rol
Els següents objectes són relacionats amb l'API `role`.
[comment]: # ({/2135842b-2135842b})
[comment]: # ({84851cb3-1708e020})
### Rol
L'objecte rol té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|roleid|string|ID del rol.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *només lectura*
- *obligatori* per operacions d'actualització|
|name|string|Nom de la funció.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori* per operacions de creació|
|type|integer|Tipus d'usuari.
Valors possibles:
1 - *(per defecte)* Usuari;
2 - Administrador;< br>3 - Super administrador.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori* per operacions de creació|
|readonly|integer|*(només lectura)* Indica si la funció és només de lectura.
Valors possibles:
0 - *(per defecte)* No;
1 - Sí.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *només lectura|
[comment]: # ({/84851cb3-1708e020})
[comment]: # ({a9f09416-8a9b3008})
### Regles de rols
L'objecte de regles de rol té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|ui|array|Matriu d'objectes [element UI](object#ui_element).|
|ui.default\_access|integer|Indica si l'accés als nous elements de la IU és activat.
Valors possibles:
0 - Desactivat;
1 - *(per defecte )* Activat.|
|services.read.mode|integer|Accés de només lectura als serveis.
Valors possibles:
0 - Accés només de lectura als serveis, especificat per la propietat `services.read.list ` o coincident amb la propietat `services.read.tag`.
1 - *(per defecte)* Accés només de lectura a tots els serveis.|
|services.read.list|array|Matriu d'objectes [servei](object#service).
Els serveis especificats, inclosos els serveis secundaris, tindran accés de només lectura a la funció d'usuari. L'accés de només lectura no anul·larà pas l'accés de lectura i escriptura als serveis.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *admès* si `services.read.mode` és "0"|
|services.read.tag|object|Matriu d'objectes [etiqueta de servei](object#service_tag).
Els serveis que coincideixin amb les etiquetes, inclosos els serveis secundaris, tindran accés només de lectura al rol d'usuari. L'accés de només lectura no anul·larà l'accés de lectura i escriptura als serveis.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *admès* si `services.read.mode` és "0"|
|services.write.mode|integer|Accés de lectura i escriptura als serveis.
Valors possibles:
0 - (per defecte) Accés de lectura i escriptura als serveis, especificat per la propietat `services.write .list` o corresponent a la propietat `services.write.tag`.
1 - Accés de lectura i escriptura a tots els serveis.|
|services.write.list|array|Matriu d'objectes [servei](object#service).
Els serveis especificats, inclosos els serveis secundaris, tindran accés de lectura i escriptura a la funció d'usuari. L'accés de lectura i escriptura substituirà l'accés de només lectura als serveis.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *admès* si `services.write.mode` és "0"|
|services.write.tag|object|Matriu d'objectes [etiqueta de servei](object#service_tag).
Els serveis que coincideixin amb les etiquetes, inclosos els serveis secundaris, tindran accés de lectura i escriptura al rol d'usuari. L'accés de lectura i escriptura substituirà l'accés de només lectura als serveis.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *admès* si `services.write.mode` és "0"|
|mòduls|matriu|Matriu d'objectes [mòdul](objecte#mòdul).|
|modules.default\_access|integer|Indica si l'accés als mòduls nous és activat.
Valors possibles:
0 - Desactivat;
1 - *(per defecte)* Activat.|
|api.access|integer|Indica si l'accés a l'API és actiu.
Valors possibles:
0 - Desactivat;
1 - *(per defecte)* Activat.|
|api.mode|integer|Mode de processament dels mètodes de l'API enumerats a la propietat `api`.
Valors possibles:
0 - *(per defecte)* Llista denegada;
1 - Llista d'autoritzacions.|
|api|array|Matriu de mètodes API.|
|actions|array|Matriu d'objectes [acció](objecte#acció).|
|actions.default\_access|integer|Indica si l'accés a noves accions és activat.
Valors possibles:
0 - Desactivat;
1 - *(per defecte)* Activat.|
[comment]: # ({/a9f09416-8a9b3008})
[comment]: # ({4375b5d1-006cdfb5})
### Element UI
L'objecte d'element d'UI té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|name|string|Nom de l'element de la UI.
Valors possibles per a tot tipus d'usuaris:
`monitoring.dashboard` - *Monitoratge → Taulers de control d'equips*;
`monitoring.problems` - *Monitoratge → Problemes*;
`monitoring.hosts` - *Monitoratge → Equips*;
`monitoring.latest_data` - *Monitoratge → Dades més recents*; < br>`monitoring.maps` - *Monitoratge → Mapes*;
`services.services` - *Serveis → Serveis*;
`services.sla_report` - *Serveis → Informe SLA*;
` inventory.overview` - *Inventari → Visió general*;
`inventory.hosts` - *Inventari → Equips*;
`reports.availability_report` - *Informes → Informe de disponibilitat*;
`reports.top_triggers ` - *Informes → 100 triggers principals*.
Els valors només són possibles per als usuaris de tipus d'usuari *Admin* i *Super admin*:
`monitoring.discovery` - *Monitoratge → Descoberta*;
`services.actions` - *Serveis → Accions de servei*;
`services.sla` - *Serveis → SLA*;
`informes. scheduled_reports` - *Informes → Informes programats*;
`reports.notifications` - *Informes → Notificacions*;
`configuration.host_groups` - *Configuració → Grups d'equips*;
`configuration.templates ` - *Configuració → Plantilles*;
`configuration.hosts` - *Configuració → Equips*;
`configuration.maintenance` - *Configuració → Manteniment*;
`configuration.actions` - *Configuració → Accions* ;
`configuration.discovery` - *Configuració → Descoberta*.
Els valors només són possibles per als usuaris *superadministrador*:
`reports.system_info` - *Informes → Informació del sistema*;
`reports.audit` - *Informes → Auditoria*;
`reports.action_log` - *Informes → Registre d'accions*;
`configuration.event_correlation` - *Configuració → Correlació d'esdeveniments*;
`administration.general` - *Administració → General*;
`administration.proxies` - *Administració → Proxys*;
`administration.authentication` - *Administració → Autenticació*;
`administration.user _groups` - *Administració → Grups d'usuaris*;
`administration.user_roles` - *Administració → Rols d'usuari*;
`administration.users` - *Administració → Usuaris*;
`administration.media_types` - *Administració → Tipus de suport*;
`administration.scripts` - *Administració → Scripts*;
`administration.queue` - *Administració → Cua*.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori*|
|status|integer|Indica si l'accés a l'element de la IU és permès.
Valors possibles:
0 - Desactivat;
1 - *(per defecte)* Activat .|
[comment]: # ({/4375b5d1-006cdfb5})
[comment]: # ({b8603f6e-ebf4bb3a})
### Servei
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|serviceid|ID del servei.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori*|
[comment]: # ({/b8603f6e-ebf4bb3a})
[comment]: # ({1e4d9d21-300e6d5b})
### Etiqueta de servei
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|tag|string|Nom de l'etiqueta.
Si s'especifica una cadena buida, l'etiqueta de servei no s'emprarà per fer coincidir el servei.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori*|
|value|string|Valor de l'etiqueta.
Si no s'especifica cap valor o una cadena buida, només s'emprarà el nom de l'etiqueta per a la concordança del servei.|
[comment]: # ({/1e4d9d21-300e6d5b})
[comment]: # ({21d1ba7b-f70e75e9})
### Mòdul
L'objecte mòdul té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|moduleid|string|ID del mòdul.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori*|
|status|integer|Diu si l'accés al mòdul és habilitat.
Valors possibles:
0 - Inhabilitat;
1 - *(per defecte)* Habilitat.|
[comment]: # ({/21d1ba7b-f70e75e9})
[comment]: # ({cd7f3b4c-957a00bb})
### Acció
L'objecte té les propietats següents:
|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|name|string|Nom de l'acció.
Valors possibles per a usuaris de tot tipus:
`edit_dashboards` - Crear i editar taulers de control ;
`edit_maps` - Crear i editar mapes;
`add_problem_comments` - Afegeix comentaris de problemes;
`change_severity` - Canvia la gravetat del problema;
`acknowledge_problems` - Reconeix els problemes dels problemes;
`close_problems` - Tanca problemes;
`execute_scripts`: executa scripts;
`manage_api_tokens`: gestiona els testimonis de l'API.
Els valors només són possibles per als usuaris dels tipus d'usuari "Admin" i "Super admin":
` edit_maintenance` - Crear i editar manteniments;
`manage_scheduled_reports` - Gestionar informes programats,
`manage_sla` - Gestionar SLA.
Valors possibles si `type` de l'[objecte Rol](#role) és "User" o "Admin":
`invoke_execute_now` - permet executar els elements marcats per usuaris que tenen només permisos de lectura a l'equip.
[Comportament de la propietat](/manual/api/reference_commentary#property-behavior):
- *obligatori*|
|status|integer|Indica si l'accés per dur a terme l'acció és habilitat.
Valors possibles:
0 - Desactivat;
1 - *(per defecte)* Activat.|
[comment]: # ({/cd7f3b4c-957a00bb})