Documentation
Table of Contents
> Gebruikersobject
De volgende objecten zijn direct gerelateerd aan de user API.
Gebruiker
Het gebruikersobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| userid | string | ID van de gebruiker. Eigenschapsgedrag: - alleen-lezen - vereist voor bijgewerkte bewerkingen |
| gebruikersnaam | string | Naam van de gebruiker. Eigenschapsgedrag: - vereist voor aanmaakbewerkingen - alleen-lezen voor voorzien van gebruikers als de gebruiker gekoppeld is aan een gebruikersmap ( gebruikersmapid is ingesteld op een geldige waarde die niet "0" is), en de voorzieningsstatus van de gebruikersmap is ingeschakeld (provision_status van Gebruikersmapobject is ingesteld op "1"), en de authenticatiestatus van alle LDAP- of SAML-voorziening is ingeschakeld (ldap_jit_status van Authenticatieobject is ingesteld op "Enabled for configured LDAP IdPs" of saml_jit_status van Authenticatieobject is ingesteld op "Enabled for configured SAML IdPs") |
| wachtwoord | string | Wachtwoord van de gebruiker. De waarde van deze parameter kan een lege string zijn als de gebruiker gekoppeld is aan een gebruikersmap. Eigenschapsgedrag: - alleen-schrijven |
| rolid | string | Rol-ID van de gebruiker. |
| poging_klok | timestamp | Tijd van de laatste onsuccesvolle aanmeldpoging. Eigenschapsgedrag: - alleen-lezen |
| poging_mislukt | integer | Aantal recente mislukte aanmeldpogingen. Eigenschapsgedrag: - alleen-lezen |
| poging_ip | string | IP-adres waarvandaan de laatste onsuccesvolle aanmeldpoging afkomstig was. Eigenschapsgedrag: - alleen-lezen |
| autologin | integer | Of automatisch aanmelden is ingeschakeld. Mogelijke waarden: 0 - (standaard) automatisch aanmelden uitgeschakeld; 1 - automatisch aanmelden ingeschakeld. |
| autologout | string | Levensduur van de gebruikerssessie. Accepteert seconden en een tijdeenheid met achtervoegsel. Als ingesteld op 0s, zal de sessie nooit verlopen. Standaard: 15m. |
| taal | string | Taalcode van de taal van de gebruiker, bijvoorbeeld, nl_NL.Standaard: default - systeemstandaard. |
| naam | string | Naam van de gebruiker. |
| vernieuwen | string | Automatische vernieuwingsperiode. Accepteert seconden of een tijdeenheid met achtervoegsel (bijv. 30s, 90s, 1m, 1h). Standaard: 30s. |
| rijen_per_pagina | integer | Aantal rijen van objecten om per pagina te tonen. Standaard: 50. |
| achternaam | string | Achternaam van de gebruiker. |
| thema | string | Thema van de gebruiker. Mogelijke waarden: default - (standaard) systeemstandaard;blue-theme - Blauw;dark-theme - Donker. |
| ts_voorzien | timestamp | Tijd waarop de laatste voorzienings operatie werd uitgevoerd. Eigenschapsgedrag: - alleen-lezen |
| url | string | URL van de pagina om de gebruiker na het aanmelden naar door te verwijzen. |
| gebruikersmapid | string | ID van de gebruikersmap waaraan de gebruiker is gekoppeld. Wordt gebruikt voor voorziening (aanmaken of bijwerken), evenals om een gebruiker aan te melden die gekoppeld is aan een gebruikersmap. Voor aanmeldingsbewerkingen heeft de waarde van deze eigenschap prioriteit boven de gebruikersmapid eigenschap van gebruikersgroepen waartoe de gebruiker behoort.Standaard: 0. |
| tijdzone | string | Tijdzone van de gebruiker, bijvoorbeeld, Europe/Amsterdam, UTC.Standaard: default - systeemstandaard.Voor de volledige lijst met ondersteunde tijdzones raadpleegt u de PHP-documentatie. |
Media
Het media-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| mediatypeid | string | ID van het mediatype dat door de media wordt gebruikt. Eigenschapsgedrag: - vereist |
| sendto | string/array | Adres, gebruikersnaam of andere identificator van de ontvanger. Als type van het Mediatype is ingesteld op "E-mail", worden waarden weergegeven als een array. Voor andere Mediatypen wordt de waarde weergegeven als een tekenreeks.Eigenschapsgedrag: - vereist |
| actief | integer | Of het medium is ingeschakeld. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
| ernst | integer | Triggerernst om meldingen over te verzenden. Ernst wordt in binaire vorm opgeslagen, waarbij elke bit de overeenkomstige ernst vertegenwoordigt. Bijvoorbeeld, "12" is gelijk aan "1100" in binair en betekent dat meldingen zullen worden verzonden van triggers met ernsten "waarschuwing" en "gemiddeld". Zie de triggerobjectpagina voor een lijst van ondersteunde triggerernsten. Standaard: 63. |
| periode | string | Tijd wanneer de meldingen kunnen worden verzonden als een tijdperiode of gebruikersmacro's gescheiden door een puntkomma. Standaard: 1-7,00:00-24:00. |