User

The User Model

Field
Type
Description
authenticationToken
String
A token generated for the user via the Create Authentication Token method.
contacts
Array<String>
An array of user's contacts (email, phone number, etc).
email
String
required
User's email. If a login is specified, this field can be omitted.
eventFilter
An array of event filters configured for the user.
group
String
The ID of a group the user belongs to.
id
String
User's ID.
language
String
User's language in RFC5646-compliant format. For more details plase visit https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl
login
String
required
User's login. If the field is not specified, a login is created based on a user's email.
objectPermissions.exclude
Array<String>
An array of objects' IDs to which the user has the exclude permission. See an article about permissions for details.
objectPermissions.include
Array<String>
An array of objects' IDs to which the user has the include permission. See an article about permissions for details.
permissions
Array<String>
An array of permissions available to the user. See an article about permissions for details.
pushFilter
Map<ObjectID, Array<ObjectStateID>>
A map that corresponds to a filter for push notifications. Each key of the map is an object ID, each value is an array of object's state IDs for which the user DOES NOT receive notifications.
source.sourceType
Integer
This parameters specifies a way to authenticate the user. Possible values are equal to 1 and 0 (or null). In the first case, the authentication is performed via LDAP server. In the second one, a standard authentication is used.
status
Integer
User's status. See below.
uiSettings.muteSystemSounds
Boolean
If set to true, system sounds (e.g. one that appears after the server is updated) are be disabled.

User's status

Value
Status
Description
0
NeedActivation
The user created their account via registration form in the web interface, having set the password. To change the status to Active the user must activate their account by clicking the link from the email-notification.
1
NeedActivationWithPassword
The account was created without user's activity, the password had not been set. To change the status to Active the user must activate their account by clicking the link from the email-notification and set the password.
2
Active
The user has access to the system.
3
Blocked
The access to the system is denied for the user.
Last modified 1mo ago