Objet utilisateur

Les objets suivants sont directement liés à l'API user.

Utilisateur

L'objet utilisateur possède les propriétés suivantes.

Property Type Description
userid ID ID de l'utilisateur.

Comportement de la propriété :
- en lecture seule
- obligatoire pour les opérations de mise à jour
username string Nom de l'utilisateur.

Comportement de la propriété :
- obligatoire pour les opérations de création
- en lecture seule pour les utilisateurs provisionnés si l'utilisateur est lié à un annuaire d'utilisateurs (userdirectoryid est défini sur une valeur valide différente de « 0 »), que le provisionnement de l'annuaire d'utilisateurs est activé (provision_status de l'objet annuaire d'utilisateurs est défini sur « 1 ») et que l'authentification de tous les provisionnements LDAP ou SAML est activée (ldap_jit_status de l'objet authentification est défini sur « Enabled for configured LDAP IdPs » ou saml_jit_status de l'objet authentification est défini sur « Enabled for configured SAML IdPs »)
passwd string Mot de passe de l'utilisateur.

La valeur de ce paramètre peut être une chaîne vide si l'utilisateur est lié à un annuaire d'utilisateurs.

Comportement de la propriété :
- en écriture seule
roleid ID ID du rôle de l'utilisateur.

Notez que les utilisateurs sans rôle peuvent se connecter à Zabbix uniquement à l'aide de l'authentification LDAP ou SAML, à condition que leurs informations LDAP/SAML correspondent aux mappages de groupes d'utilisateurs configurés dans Zabbix.
attempt_clock timestamp Heure de la dernière tentative de connexion infructueuse.

Comportement de la propriété :
- en lecture seule
attempt_failed integer Nombre récent de tentatives de connexion infructueuses.

Comportement de la propriété :
- en lecture seule
attempt_ip string Adresse IP depuis laquelle la dernière tentative de connexion infructueuse a été effectuée.

Comportement de la propriété :
- en lecture seule
autologin integer Indique s'il faut activer la connexion automatique.

Valeurs possibles :
0 - (par défaut) connexion automatique désactivée ;
1 - connexion automatique activée.
autologout string Durée de vie de la session utilisateur. Accepte un nombre de secondes (par exemple, 1, 60, 300) ou une valeur avec un suffixe temporel (par exemple, 30s, 1m, 2h). Si la valeur est définie sur 0s, la session n'expire jamais.

Valeur par défaut : 15m.
lang string Code de la langue de l'utilisateur, par exemple en_US.

Valeur par défaut : default - valeur par défaut du système.
name string Prénom de l'utilisateur.
provisioned integer Indique si l'utilisateur a été provisionné.

Valeurs possibles :
0 - non provisionné ;
1 - provisionné.

Cette propriété est prise en charge depuis Zabbix 7.0.9.

Comportement de la propriété :
- en lecture seule
refresh string Période d'actualisation automatique. Accepte un nombre de secondes (par exemple, 1, 60, 300) ou une valeur avec un suffixe temporel (par exemple, 30s, 1m, 2h, 1d).

Valeur par défaut : 30s.
rows_per_page integer Nombre de lignes d'objets à afficher par page.

Valeur par défaut : 50.
surname string Nom de famille de l'utilisateur.
theme string Thème de l'utilisateur.

Valeurs possibles :
default - (par défaut) valeur par défaut du système ;
blue-theme - Bleu ;
dark-theme - Sombre ;
hc-light - Clair à contraste élevé ;
hc-dark - Sombre à contraste élevé.
ts_provisioned timestamp Heure à laquelle la dernière opération de provisionnement a été effectuée.

Comportement de la propriété :
- en lecture seule
- pris en charge pour les utilisateurs de type Super administrateur (depuis Zabbix 7.0.9)
url string URL de la page vers laquelle rediriger l'utilisateur après sa connexion.
userdirectoryid ID ID de l'annuaire d'utilisateurs auquel l'utilisateur est lié.

Utilisé pour le provisionnement (création ou mise à jour), ainsi que pour connecter un utilisateur lié à un annuaire d'utilisateurs.

Pour les opérations de connexion, la valeur de cette propriété est prioritaire sur la propriété userdirectoryid des groupes d'utilisateurs auxquels appartient l'utilisateur.

Valeur par défaut : 0.

Comportement de la propriété :
- en lecture seule
- pris en charge pour les utilisateurs de type Super administrateur (depuis Zabbix 7.0.9)
timezone string Fuseau horaire de l'utilisateur, par exemple Europe/London, UTC.

Valeur par défaut : default - valeur par défaut du système.

Pour obtenir la liste complète des fuseaux horaires pris en charge, consultez la documentation PHP.

Media

L'objet media possède les propriétés suivantes.

Property Type Description
mediaid ID ID du media de l'utilisateur.

Comportement de la propriété:
- lecture seule
mediatypeid ID ID du type de media utilisé par le media de l'utilisateur.

Comportement de la propriété:
- obligatoire
sendto string/array Adresse, nom d'utilisateur ou autre identifiant du destinataire.

Si type de Media type est défini sur "Email", les valeurs sont représentées sous forme de tableau. Pour les autres types de Media types, la valeur est représentée sous forme de chaîne.

Comportement de la propriété:
- obligatoire
active integer Indique si le media est activé.

Valeurs possibles :
0 - (par défaut) activé;
1 - désactivé.
severity integer Sévérités de déclencheur pour lesquelles envoyer des notifications.

Valeurs bitmap possibles :
1 - Non classé;
2 - Information;
4 - Avertissement;
8 - Moyenne;
16 - Élevée;
32 - Désastre.

Il s'agit d'un champ bitmask ; toute somme des valeurs bitmap possibles est acceptable (par exemple, 48 pour Moyenne, Élevée et Désastre).

Par défaut : 63.
period string Moment où les notifications peuvent être envoyées, sous forme de période de temps ou de macros utilisateur séparées par un point-virgule.

Par défaut : 1-7,00:00-24:00.
provisioned integer Indique si l'utilisateur a été provisionné.

Valeurs possibles :
0 - non provisionné;
1 - provisionné.

Cette propriété est prise en charge depuis Zabbix 7.0.9.
userdirectory_mediaid ID ID de mappage media du répertoire utilisateur pour les media provisionnés.

Comportement de la propriété:
- lecture seule
- pris en charge pour les utilisateurs de type Super admin (depuis Zabbix 7.0.9)