Objet rôle

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

Rôle

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

Propriété Type Description
roleid ID ID du rôle.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
name string Nom du rôle.

Comportement de la propriété :
- obligatoire pour les opérations de création
type integer Type d'utilisateur.

Valeurs possibles :
1 - (par défaut) Utilisateur ;
2 - Admin ;
3 - Super admin.

Comportement de la propriété :
- obligatoire pour les opérations de création
readonly integer Indique si le rôle est en lecture seule.

Valeurs possibles :
0 - (par défaut) Non ;
1 - Oui.

Comportement de la propriété :
- lecture seule

Règles de rôle

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

Propriété Type Description
ui array Tableau d'objets élément d'interface utilisateur.
ui.default_access integer Indique si l'accès aux nouveaux éléments d'interface utilisateur est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.
services.read.mode integer Accès en lecture seule aux services.

Valeurs possibles :
0 - Accès en lecture seule aux services spécifiés par les propriétés services.read.list ou correspondant à services.read.tag ;
1 - (par défaut) Accès en lecture seule à tous les services.
services.read.list array Tableau d'objets Service.

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.

Comportement de la propriété :
- pris en charge si services.read.mode est défini sur "0"
services.read.tag object Tableau d'objets balise de service.

Les services correspondant à la balise, 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.

Comportement de la propriété :
- pris en charge si services.read.mode est défini sur "0"
services.write.mode integer Accès en lecture-écriture aux services.

Valeurs possibles :
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 ;
1 - Accès en lecture-écriture à tous les services.
services.write.list array Tableau d'objets Service.

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.

Comportement de la propriété :
- pris en charge si services.write.mode est défini sur "0"
services.write.tag object Tableau d'objets balise de service.

Les services correspondant à la balise, 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.

Comportement de la propriété :
- pris en charge si services.write.mode est défini sur "0"
modules array Tableau d'objets module.
modules.default_access integer Indique si l'accès aux nouveaux modules est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.
api.access integer Indique si l'accès à l'API est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.
api.mode integer Mode de traitement des méthodes d'API répertoriées dans la propriété api.

Valeurs possibles :
0 - (par défaut) Liste de refus ;
1 - Liste d'autorisation.
api array Tableau de méthodes d'API.
actions array Tableau d'objets action.
actions.default_access integer Indique si l'accès aux nouvelles actions est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.

Élément d'interface utilisateur

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

Property Type Description
name string Nom de l'élément d'interface utilisateur.

Valeurs possibles si type de l'objet Role est défini sur "User", "Admin" ou "Super admin" :
monitoring.dashboard - Tableaux de bord;
monitoring.problems - Supervision → Problèmes;
monitoring.hosts - Supervision → Hôtes;
monitoring.latest_data - Supervision → Dernières données;
monitoring.maps - Supervision → Cartes;
services.services - Services → Services;
services.sla_report - Services → Rapport SLA;
inventory.overview - Inventaire → Vue d'ensemble;
inventory.hosts - Inventaire → Hôtes;
reports.availability_report - Rapports → Rapport de disponibilité;
reports.top_triggers - Rapports → Top 100 des déclencheurs.

Valeurs possibles si type de l'objet Role est défini sur "Admin" ou "Super admin" :
monitoring.discovery - Supervision → Découverte;
services.sla - Services → SLA;
reports.scheduled_reports - Rapports → Rapports planifiés;
reports.notifications - Rapports → Notifications;
configuration.template_groups - Collecte de données → Groupes de modèles;
configuration.host_groups - Collecte de données → Groupes d'hôtes;
configuration.templates - Collecte de données → Modèles;
configuration.hosts - Collecte de données → Hôtes;
configuration.maintenance - Collecte de données → Maintenance;
configuration.discovery - Collecte de données → Découverte;
configuration.trigger_actions - Alertes → Actions → Actions sur les déclencheurs;
configuration.service_actions - Alertes → Actions → Actions sur les services;
configuration.discovery_actions - Alertes → Actions → Actions de découverte;
configuration.autoregistration_actions - Alertes → Actions → Actions d'auto-enregistrement;
configuration.internal_actions - Alertes → Actions → Actions internes.

Valeurs possibles si type de l'objet Role est défini sur "Super admin" :
reports.system_info - Rapports → Informations système;
reports.audit - Rapports → Journal d'audit;
reports.action_log - Rapports → Journal des actions;
configuration.event_correlation - Collecte de données → Corrélation d'événements;
administration.media_types - Alertes → Types de média;
administration.scripts - Alertes → Scripts;
administration.user_groups - Utilisateurs → Groupes d'utilisateurs;
administration.user_roles - Utilisateurs → Rôles utilisateur;
administration.users - Utilisateurs → Utilisateurs;
administration.api_tokens - Utilisateurs → Jetons d'API;
administration.authentication - Utilisateurs → Authentification;
administration.general - Administration → Général;
administration.audit_log - Administration → Journal d'audit;
administration.housekeeping - Administration → Housekeeping;
administration.proxy_groups - Administration → Groupes de proxys;
administration.proxies - Administration → Proxys;
administration.macros - Administration → Macros;
administration.queue - Administration → File d'attente.

Comportement des propriétés :
- obligatoire
status integer Indique si l'accès à l'élément d'interface utilisateur est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.

Service

Propriété Type Description
serviceid ID ID du service.

Comportement de la propriété :
- obligatoire

Tag de service

Propriété Type Description
tag string Nom du tag.

Si une chaîne vide est spécifiée, le tag de service ne sera pas utilisé pour la correspondance des services.

Comportement de la propriété:
- obligatoire
value string Valeur du tag.

Si aucune valeur ou une chaîne vide est spécifiée, seul le nom du tag sera utilisé pour la correspondance des services.

Module

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

Propriété Type Description
moduleid ID ID du module.

Comportement de la propriété :
- obligatoire
status integer Indique si l'accès au module est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.

Action

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

Propriété Type Description
name string Nom de l'action.

Valeurs possibles si type de l'objet Role est défini sur "User", "Admin" ou "Super admin" :
edit_dashboards - Créer et modifier des tableaux de bord ;
edit_maps - Créer et modifier des cartes ;
add_problem_comments - Ajouter des commentaires sur les problèmes ;
change_severity - Modifier la sévérité du problème ;
acknowledge_problems - Acquitter les problèmes ;
suppress_problems - Supprimer les problèmes ;
close_problems - Fermer les problèmes ;
execute_scripts - Exécuter des scripts ;
manage_api_tokens - Gérer les jetons d'API ;
change_problem_ranking - Modifier le classement du problème de cause à symptôme, et inversement ;
edit_own_media - Autoriser la création/modification de ses propres médias.

Valeurs possibles si type de l'objet Role est défini sur "Admin" ou "Super admin" :
edit_maintenance - Créer et modifier des périodes de maintenance ;
manage_scheduled_reports - Gérer les rapports planifiés,
manage_sla - Gérer les SLA.

Valeurs possibles si type de l'objet Role est défini sur "User" ou "Admin" :
invoke_execute_now - permet d'exécuter des vérifications d'éléments pour les utilisateurs qui n'ont que des droits de lecture sur l'hôte.

Valeurs possibles si type de l'objet Role est défini sur "Super admin" :
edit_user_media - Autoriser la création/modification de médias pour les utilisateurs.

Comportement de la propriété :
- obligatoire
status integer Indique si l'accès pour effectuer l'action est activé.

Valeurs possibles :
0 - Désactivé ;
1 - (par défaut) Activé.