Documentation
Table of Contents
> Objet Utilisateur
Les objets suivants sont directement liés à l'API user.
Utilisateur
L'objet utilisateur a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| userid | string | (lecture seule) ID de l'utilisateur. |
| username (obligatoire) |
string | Nom d'utilisateur. |
| roleid (obligatoire) |
string | ID du rôle de l'utilisateur. |
| attempt_clock | timestamp | (lecture seule) Heure de la dernière tentative de connexion infructueuse. |
| attempt_failed | integer | (lecture seule) Nombre récent de tentatives de connexion infructueuses. |
| attempt_ip | string | (lecture seule) Adresse IP d'où provient la dernière tentative de connexion infructueuse. |
| autologin | integer | Activer ou non la connexion automatique. Valeurs possibles : 0 - (par défaut) auto-login désactivé ; 1 - auto-login activé. |
| autologout | string | Durée de vie de la session utilisateur. Accepte les secondes et les unités de temps avec suffixe. Si défini sur 0s, la session n'expirera jamais. Par défaut : 15m. |
| lang | string | Code de langue de la langue de l'utilisateur, par exemple, fr_FR.Par défaut : default - par défaut du système. |
| name | string | Nom de l'utilisateur. |
| refresh | string | Période de rafraîchissement automatique. Accepte les secondes et les unités de temps avec suffixe. Par défaut : 30s. |
| rows_per_page | integer | Nombre de lignes d'objet à afficher par page. 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) système par défaut ;blue-theme - Bleu ;dark-theme - Foncé. |
| url | string | URL de la page vers laquelle rediriger l'utilisateur après la connexion. |
| timezone | string | Fuseau horaire de l'utilisateur, par exemple, Europe/Paris, UTC.Par défaut : default - défaut système.Pour la liste complète des fuseaux horaires pris en charge, veuillez consulter la Documentation PHP. |
| roleid (obligatoire) |
string | ID de rôle de l'utilisateur. |
| alias (obsolète) |
string | Cette propriété est obsolète, veuillez utiliser username à la place.Alias utilisateur. |
Notez que pour certaines méthodes (mise à jour, suppression) la combinaison de paramètres requise/optionnelle est différente.
Média
L'objet média a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| mediatypeid (obligatoire) |
string | ID du type de média utilisé par le média. |
| sendto (obligatoire) |
string/array | Adresse, nom d'utilisateur ou autre identifiant du destinataire. Si le type de média est e-mail, les valeurs sont représentées sous forme de tableau. Pour les autres types de média, la valeur est représentée par une chaîne. |
| active | integer | Indique si le média est activé. Valeurs possibles : 0 - (par défaut) activé ; 1 - désactivé. |
| severity | integer | Sévérités des déclencheurs pour lesquelles envoyer des notifications. Les sévérités sont stockées sous forme binaire, chaque bit représentant la sévérité correspondante. Par exemple, 12 est égal à 1100 en binaire et signifie que les notifications seront envoyées à partir de déclencheurs de sévérités avertissement et moyen. Reportez-vous à la page d'objet déclencheur pour obtenir une liste des sévérités de déclencheurs prises en charge. Par défaut : 63 |
| period | string | Heure à laquelle les notifications peuvent être envoyées sous forme de période ou de macros utilisateur séparées par un point-virgule. Par défaut : 1-7,00:00-24:00 |