NameDescriptionTypeAdditional information
Name The name of the user.
string

None.

Phone The contact phone number.
string

None.

Email The email used to sign in.
string

Required.

FailedLoginAttempts If a user tries to log in but fails this counter is incremented
The counter is reset on successful log in
integer

None.

UsesTotp Whether or not the user is using time-based one-time password (TOTP)
Property is read only
Use TOTP end points to generate and verify time-based one-time password
boolean

None.

MfaIgnored boolean

None.

SecretKey Only used when getting secret key the first time.
string

None.

Locked A locked user cannot use the system
User can be locked by another user of due to too many failed sign-in attempts
boolean

None.

DateFormat The user's preferred date format. E.g. yyyy-MM-dd for 2014-12-31
string

None.

DateFormatInitialized Date format that cannot be null as default date format will be used
string

None.

TimeFormat The user's preferred time format. E.g. HH:mm:ss for 21:14:23 or h:mm:ss tt for 9:14:23 PM.
string

None.

TimeFormatInitialized Time format that cannot be null as default time format will be used
string

None.

DateTimeFormat The user's preferred date and time format combined
Read only
string

None.

DateAtTimeFormat The user's preferred date and time format combined with an @ for easy readability
Read only
string

None.

CsvDelimiter The user's preferred delimiter for CSV data.
string

None.

DecimalMark The user's preferred decimal mark.
string

None.

Role The role of the user and the definition of which privileges the user is granted
Role

Required.

LastLoginDate The last time the user signed in.
date

Read-only.

LastPasswordChange Date the user last changed their password
Mainly relevant if business unit of user or ancestor demands passwords to change
date

Read-only.

BusinessUnit The business unit to which the user belongs.
BusinessUnit

None.

Language The user's preferred language.
Language

Required.

EmailIntroduction Introduction text for emails.
string

None.

EmailSignature Signature text for emails.
string

None.

CommentFreeText The comment free text.
string

None.

ReceiveCommentNotifications Indicating whether the user will receive comment notifications.
boolean

None.

ReceiveDeleteRequestNotifications Indicating whether the user will receive deletion request notifications.
boolean

None.

ReportErrorConfig A report error configuration.
ReportErrorConfig

If left unspecified, the system will default to the user's business unit's (or an inherited) report error config.

UseOwnReportErrorConfig If this is set to true the report error config managed by the user will be
used when viewing status and node reports. Otherwise local report error config
of the business unit will be applied.
Default is false
boolean

None.

GroupStatusReportByBusinessUnits When viewing status reports the corresponding node reports will be displayed in one
list if this setting is false. Otherwise they will be grouped by the business unit
owning the backup node/virtual machine.
Default is false
boolean

None.

ItemsPerPage When viewing status reports this setting will dictate how many consumption units are viewed per page
Default is 100
integer

None.

Keychain The user's keychain for server access.
Collection of ServerCredentials

None.

ExcludeJobTags Whether items matching tags should be excluded in job reports
boolean

None.

UserIdentities Collection of UserIdentity

None.

DisplayName The display name for the user. Returns the user's name; or the email if the name is not set.
string

Read-only.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.