Table of Contents
> Gebruikersobject
De volgende objecten zijn direct gerelateerd aan de user API.
Gebruiker
Het gebruikersobject heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| userid | string | (alleen lezen) ID van de gebruiker. |
| username (vereist) |
string | Gebruikersnaam. |
| roleid (vereist) |
string | Rol-ID van de gebruiker. |
| attempt_clock | timestamp | (alleen lezen) Tijdstip van de laatste onsuccesvolle aanmeldingspoging. |
| attempt_failed | integer | (alleen lezen) Aantal recente mislukte aanmeldingspogingen. |
| attempt_ip | string | (alleen lezen) IP-adres waarvandaan de laatste onsuccesvolle aanmeldingspoging afkomstig was. |
| autologin | integer | Of automatisch aanmelden ingeschakeld moet worden. Mogelijke waarden: 0 - (standaard) automatisch aanmelden uitgeschakeld; 1 - automatisch aanmelden ingeschakeld. |
| autologout | string | Levensduur van de gebruikerssessie. Accepteert seconden en tijdseenheid met achtervoegsel. Als dit is ingesteld op 0s, verloopt de sessie nooit. Standaard: 15m. |
| lang | string | Taalcode van de taal van de gebruiker, bijvoorbeeld nl_NL.Standaard: default - systeemstandaard. |
| name | string | Naam van de gebruiker. |
| refresh | string | Automatische vernieuwingsperiode. Accepteert seconden of tijdseenheid met achtervoegsel (bijv. 30s, 90s, 1m, 1u). Standaard: 30s. |
| rows_per_page | integer | Aantal objectrijen dat per pagina wordt weergegeven. Standaard: 50. |
| surname | string | Achternaam van de gebruiker. |
| theme | string | Thema van de gebruiker. Mogelijke waarden: default - (standaard) systeemstandaard;blue-theme - Blauw;dark-theme - Donker. |
| url | string | URL van de pagina waarnaar de gebruiker wordt doorgestuurd na het inloggen. |
| timezone | string | Tijdzone van de gebruiker, bijvoorbeeld Europe/Amsterdam, UTC.Standaard: default - systeemstandaard.Voor de volledige lijst met ondersteunde tijdzones, raadpleeg de PHP-documentatie. |
| alias (verouderd) |
string | Deze eigenschap is verouderd, gebruik in plaats daarvan username.Gebruikersalias. |
Let op: voor sommige methoden (update, delete) is de vereiste/optionele parametercombinatie anders.
Media
Het mediaobject heeft de volgende eigenschappen.
| Eigendom | Type | Beschrijving |
|---|---|---|
| mediatypeid (verplicht) |
string | ID van het mediatype dat door de media wordt gebruikt. |
| sendto (vereist) |
string/array | Adres, gebruikersnaam of andere identificatie van de ontvanger. If type of Media type is e-mail, waarden worden weergegeven als array. Voor andere typen Mediatypen wordt de waarde weergegeven als een tekenreeks. |
| active | integer | Of de media is ingeschakeld. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
| ernst | integer | Activeer ernst om meldingen over te verzenden. Ernsten worden in binaire vorm opgeslagen, waarbij elk bit de bijbehorende ernst vertegenwoordigt. Bijvoorbeeld, 12 is binair gelijk aan 1100 en betekent dat er meldingen worden verzonden vanaf triggers met een waarschuwing voor de ernst en het gemiddelde. Raadpleeg de trigger-objectpagina voor een lijst met ondersteunde trigger-ernsten. Standaard: 63 |
| periode | string | Tijd waarop de meldingen kunnen worden verzonden als time period of gebruikersmacro's gescheiden door een puntkomma. Standaard: 1-7, 00:00-24:00 |