This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

User

Object represent user object and extends UserDBObject.

Instance attributes

From UserDBObject
description: String

Description

flags: int

Flags

guid: String

GUID

id: int

Id

isDeleted: bool

TRUE if user DB object is deleted

isDisabled: bool

TRUE if user DB object is disabled

isGroup: bool

TRUE if user DB object is group object: UserGroup

isModified: bool

TRUE if user DB object is modified

isLDAPUser: bool

TRUE if user DB object is synchronized from LDAP

ldapDN: String

LDAP distinguished name (DN) of the user DB object

ldapId: String

Get user DB object LDAP id (value depends on the field that is used as LDAP object id)

name: String

Object name

systemRights: int64

Field with system rights as bit flags.

authMethod: int

Authentication method.

certMappingData: String

Data that will be used to map certificate

certMappingMethod: int

Certificate mapping methods.

disabledUntil: int

UNIX timestamp with date until this user is disabled

email: String

Email set in user properties

fullName: String

User full name

graceLogins: int

Grace login count

is2FAExempt: bool

TRUE if user is exempt from two-factor authentication enforcement.

phoneNumber: String

Phone number set in user properties

lastLogin: int

UNIX timestamp with last user’s login time

twoFAGraceLogins: int

Number of remaining logins allowed without two-factor authentication while two-factor authentication enforcement is active and the user has not configured a second factor yet. Initial value is set by server configuration variable Server.Security.2FA.GraceLoginCount.

Constants

Table 1. Authentication methods
Code Description

0

Password

1

Radius

2

Certificate

3

Certificate or password

4

Certificate or radius

5

LDAP

Table 2. Certificate mapping methods
Code Description

0

Subject

1

Public key

2

CN

3

Template ID