User

User model

Field Type Description

id

String
required

User’s ID.

login

String
required

User’s login. If the field isn’t specified, a login is created based on a user’s email.

email

String
required

User’s email. If a login is specified, this field can be omitted.

displayName

String
required

User’s display name. Used to hide user’s login information. See the Display name section for more information.

authenticationToken

String

A token generated for the user with the Create Authentication Token method.

source.sourceType

Integer

This parameters specifies a way to authenticate the user. Possible values are 0 (or null) for a standard authentication, 1 for authentication via LDAP server, 2 for Keycloak authentication.

permissions

Array<String>

An array of permissions available to the user. 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.

objectPermissions.exclude

Array<String>

An array of objects' IDs to which the user has the exclude permission. See an article about permissions for details.

activeTo

Integer

A timestamp of when to block the user (in milliseconds).

status

Integer

User’s status. See below.

contacts

Array<String>

An array of user’s contacts (email, phone number, etc).

group

Array<String>

The Array of IDs of groups the user belongs to.

language

String

User’s language in RFC5646-compliant format. For more details visit Mozilla’s JavaScript Reference

eventFilter

Array<__EventFilter>

An array of event filters configured for the user.

pushFilter

Map<ObjectID, Array<ObjectStateID>>

Push notifications filter. Each key of the map is an object ID, each value is an array of object’s state IDs for which the user doesn’t receive notifications.

uiSettings.muteSystemSounds

Boolean

If set to true, system sounds (for example, one that appears after the server is updated) are be disabled.

favorites

Favorites

List of user’s favorite entities.

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.

Owner

By default Owner is the User who created an entity. It’s possible to change Owner later on.

You can use Owner:

  • to specify a person, responsible for an entity

  • search all entities that a User owns

Display name

Display name is used to hide user’s login information. If you don’t specify the display name when you create a user, the displayName will be created automatically by masking the latter half of the login field with the * character.

Display name can’t be the same as login.

Users with manage-users permissions can change other users' display name. Users without those permissions can only change their own display name.