[comment]: # aside: 1

[comment]: # translation:outdated

[comment]: # ({70c23b61-2135842b})
# Objet rôle

Les objets suivants sont directement liés à l’API `role`.

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

[comment]: # ({4c760d03-1708e020})
### Rôle

L'objet rôle possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|roleid|ID|ID du rôle.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *lecture seule*<br>- *obligatoire* pour les opérations de mise à jour|
|name|string|Nom du rôle.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire* pour les opérations de création|
|type|integer|Type d'utilisateur.<br><br>Valeurs possibles :<br>1 - *(par défaut)* Utilisateur ;<br>2 - Admin ;<br>3 - Super admin.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire* pour les opérations de création|
|readonly|integer|Indique si le rôle est en lecture seule.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Non ;<br>1 - Oui.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *lecture seule*|

[comment]: # ({/4c760d03-1708e020})

[comment]: # ({28862318-8a9b3008})
### Règles de rôle

L'objet de règles de rôle possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|ui|array|Tableau des objets [élément d'interface](object#ui-element).|
|ui.default\_access|integer|Indique si l'accès aux nouveaux éléments d'interface est activé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|
|services.read.mode|integer|Accès en lecture seule aux services.<br><br>Valeurs possibles :<br>0 - Accès en lecture seule aux services spécifiés par les propriétés `services.read.list` ou correspondant à `services.read.tag` ;<br>1 - *(par défaut)* Accès en lecture seule à tous les services.|
|services.read.list|array|Tableau d'objets [Service](object#service).<br><br>Les services spécifiés, y compris les services enfants, accorderont un accès en lecture seule au rôle utilisateur. L'accès en lecture seule ne remplacera pas l'accès en lecture-écriture aux services.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *pris en charge* si `services.read.mode` est défini sur "0"|
|services.read.tag|object|Tableau d'objets [Tag de service](object#service-tag).<br><br>Les services correspondant au tag, y compris les services enfants, accorderont un accès en lecture seule au rôle utilisateur. L'accès en lecture seule ne remplacera pas l'accès en lecture-écriture aux services.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *pris en charge* si `services.read.mode` est défini sur "0"|
|services.write.mode|integer|Accès en lecture-écriture aux services.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Accès en lecture-écriture aux services spécifiés par les propriétés `services.write.list` ou correspondant à `services.write.tag` ;<br>1 - Accès en lecture-écriture à tous les services.|
|services.write.list|array|Tableau d'objets [Service](object#service).<br><br>Les services spécifiés, y compris les services enfants, accorderont un accès en lecture-écriture au rôle utilisateur. L'accès en lecture-écriture remplacera l'accès en lecture seule aux services.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *pris en charge* si `services.write.mode` est défini sur "0"|
|services.write.tag|object|Tableau d'objets [Tag de service](object#service-tag).<br><br>Les services correspondant au tag, y compris les services enfants, accorderont un accès en lecture-écriture au rôle utilisateur. L'accès en lecture-écriture remplacera l'accès en lecture seule aux services.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *pris en charge* si `services.write.mode` est défini sur "0"|
|modules|array|Tableau des objets [module](object#module).|
|modules.default\_access|integer|Indique si l'accès aux nouveaux modules est activé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|
|api.access|integer|Indique si l'accès à l'API est activé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|
|api.mode|integer|Mode de traitement des méthodes d'API listées dans la propriété `api`.<br><br>Valeurs possibles :<br>0 - *(par défaut)* Liste de refus ;<br>1 - Liste d'autorisation.|
|api|array|Tableau des méthodes d'API.|
|actions|array|Tableau des objets [action](object#action).|
|actions.default\_access|integer|Indique si l'accès aux nouvelles actions est activé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|

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

[comment]: # ({b7519b73-006cdfb5})
#### Élément d'interface

L'objet élément d'interface possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Nom de l'élément d'interface.<br><br>Valeurs possibles si `type` de l'objet [Role](#role) est défini sur "User", "Admin" ou "Super admin" :<br>`monitoring.dashboard` - *Tableaux de bord*;<br>`monitoring.problems` - *Monitoring → Problèmes*;<br>`monitoring.hosts` - *Monitoring → Hôtes*;<br>`monitoring.latest_data` - *Monitoring → Dernières données*;<br>`monitoring.maps` - *Monitoring → Cartes*;<br>`services.services` - *Services → Services*;<br>`services.sla_report` - *Services → Rapport SLA*;<br>`inventory.overview` - *Inventaire → Vue d'ensemble*;<br>`inventory.hosts` - *Inventaire → Hôtes*;<br>`reports.availability_report` - *Rapports → Rapport de disponibilité*;<br>`reports.top_triggers` - *Rapports → Top 100 des déclencheurs*.<br><br>Valeurs possibles si `type` de l'objet [Role](#role) est défini sur "Admin" ou "Super admin" :<br>`monitoring.discovery` - *Monitoring → Découverte*;<br>`services.sla` - *Services → SLA*;<br>`reports.scheduled_reports` - *Rapports → Rapports planifiés*;<br>`reports.notifications` - *Rapports → Notifications*;<br>`configuration.template_groups` - *Collecte de données → Groupes de modèles*;<br>`configuration.host_groups` - *Collecte de données → Groupes d'hôtes*;<br>`configuration.templates` - *Collecte de données → Modèles*;<br>`configuration.hosts` - *Collecte de données → Hôtes*;<br>`configuration.maintenance` - *Collecte de données → Maintenance*;<br>`configuration.discovery` - *Collecte de données → Découverte*;<br>`configuration.trigger_actions` - *Alertes → Actions → Actions de déclencheur*;<br>`configuration.service_actions` - *Alertes → Actions → Actions de service*;<br>`configuration.discovery_actions` - *Alertes → Actions → Actions de découverte*;<br>`configuration.autoregistration_actions` - *Alertes → Actions → Actions d'auto-enregistrement*;<br>`configuration.internal_actions` - *Alertes → Actions → Actions internes*.<br><br>Valeurs possibles si `type` de l'objet [Role](#role) est défini sur "Super admin" :<br>`reports.system_info` - *Rapports → Informations système*;<br>`reports.audit` - *Rapports → Journal d'audit*;<br>`reports.action_log` - *Rapports → Journal des actions*;<br>`configuration.event_correlation` - *Collecte de données → Corrélation d'événements*;<br>`administration.media_types` - *Alertes → Types de média*;<br>`administration.scripts` - *Alertes → Scripts*;<br>`administration.user_groups` - *Utilisateurs → Groupes d'utilisateurs*;<br>`administration.user_roles` - *Utilisateurs → Rôles utilisateur*;<br>`administration.users` - *Utilisateurs → Utilisateurs*;<br>`administration.api_tokens` - *Utilisateurs → Jetons API*;<br>`administration.authentication` - *Utilisateurs → Authentification*;<br>`administration.general` - *Administration → Général*;<br>`administration.audit_log` - *Administration → Journal d'audit*;<br>`administration.housekeeping` - *Administration → Housekeeping*;<br>`administration.proxy_groups` - *Administration → Groupes de proxy*;<br>`administration.proxies` - *Administration → Proxys*;<br>`administration.macros` - *Administration → Macros*;<br>`administration.queue` - *Administration → File d'attente*.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|status|integer|Indique si l'accès à l'élément d'interface est activé.<br><br>Valeurs possibles :<br>0 - Désactivé;<br>1 - *(par défaut)* Activé.|

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

[comment]: # ({e891a8d2-ebf4bb3a})
#### Service

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|serviceid|ID|ID du service.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *requis*|

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

[comment]: # ({62d78428-300e6d5b})
#### Tag de service

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|tag|string|Nom du tag.<br><br>Si une chaîne vide est spécifiée, le tag de service ne sera pas utilisé pour la correspondance des services.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|value|string|Valeur du tag.<br><br>Si aucune valeur ou une chaîne vide est spécifiée, seul le nom du tag sera utilisé pour la correspondance des services.|

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

[comment]: # ({bdcf5af8-f70e75e9})
#### Module

L'objet module possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|moduleid|ID|ID du module.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|status|integer|Indique si l'accès au module est activé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|

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

[comment]: # ({17265016-957a00bb})
#### Action

L'objet action possède les propriétés suivantes :

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|name|string|Nom de l'action.<br><br>Valeurs possibles si le `type` de l'objet [Role](#role) est défini sur "User", "Admin" ou "Super admin" :<br>`edit_dashboards` - Créer et modifier des tableaux de bord ;<br>`edit_maps` - Créer et modifier des cartes ;<br>`add_problem_comments` - Ajouter des commentaires de problème ;<br>`change_severity` - Modifier la sévérité du problème ;<br>`acknowledge_problems` - Acquitter les problèmes ;<br>`suppress_problems` - Supprimer les problèmes ;<br>`close_problems` - Fermer les problèmes ;<br>`execute_scripts` - Exécuter des scripts ;<br>`manage_api_tokens` - Gérer les jetons d'API ;<br>`change_problem_ranking` - Modifier le classement du problème de cause à symptôme, et inversement ;<br>`edit_own_media` - Autoriser la création/modification de ses propres médias.<br><br>Valeurs possibles si le `type` de l'objet [Role](#role) est défini sur "Admin" ou "Super admin" :<br>`edit_maintenance` - Créer et modifier des périodes de maintenance ;<br>`manage_scheduled_reports` - Gérer les rapports planifiés,<br>`manage_sla` - Gérer les SLA.<br><br>Valeurs possibles si le `type` de l'objet [Role](#role) est défini sur "User" ou "Admin" :<br>`invoke_execute_now` - permet d'exécuter des vérifications d'élément pour les utilisateurs qui n'ont que des permissions de lecture sur l'hôte.<br><br>Valeurs possibles si le `type` de l'objet [Role](#role) est défini sur "Super admin" :<br>`edit_user_media` - Autoriser la création/modification de médias pour les utilisateurs.<br><br>[Comportement de la propriété](/manual/api/reference_commentary#property-behavior) :<br>- *obligatoire*|
|status|integer|Indique si l'accès pour effectuer l'action est activé.<br><br>Valeurs possibles :<br>0 - Désactivé ;<br>1 - *(par défaut)* Activé.|

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