> User object

The following objects are directly related to the user API.

User

The user object has the following properties.

PropertyTypeDescription
useridstring(readonly) ID of the user.
username
(required)
stringUser name.
attempt_clocktimestamp(readonly) Time of the last unsuccessful login attempt.
attempt_failedinteger(readonly) Recent failed login attempt count.
attempt_ipstring(readonly) IP address from where the last unsuccessful login attempt came from.
autologinintegerWhether to enable auto-login.

Possible values:
0 - (default) auto-login disabled;
1 - auto-login enabled.
autologoutstringUser session life time. Accepts seconds and time unit with suffix. If set to 0s, the session will never expire.

Default: 15m.
langstringLanguage code of the user’s language, for example, en_GB.

Default: default - system default.
namestringName of the user.
refreshstringAutomatic refresh period. Accepts seconds and time unit with suffix.

Default: 30s.
rows_per_pageintegerAmount of object rows to show per page.

Default: 50.
surnamestringSurname of the user.
themestringUser’s theme.

Possible values:
default - (default) system default;
blue-theme - Blue;
dark-theme - Dark.
urlstringURL of the page to redirect the user to after logging in.
timezonestringUser’s time zone, for example, Europe/London, UTC.

Default: default - system default.

For the full list of supported time zones please refer to PHP documentation.
roleid
(required)
stringRole ID of the user.

Media

The media object has the following properties.

PropertyTypeDescription
mediatypeid
(required)
stringID of the media type used by the media.
sendto
(required)
string/arrayAddress, user name or other identifier of the recipient.

If type of Media type is e-mail, values are represented as array. For other types of Media types, value is represented as a string.
activeintegerWhether the media is enabled.

Possible values:
0 - (default) enabled;
1 - disabled.
severityintegerTrigger severities to send notifications about.

Severities are stored in binary form with each bit representing the corresponding severity. For example, 12 equals 1100 in binary and means, that notifications will be sent from triggers with severities warning and average.

Refer to the trigger object page for a list of supported trigger severities.

Default: 63
periodstringTime when the notifications can be sent as a time period or user macros separated by a semicolon.

Default: 1-7,00:00-24:00