import "Users.idl";
Public Attributes | |
| kerio::web::KId | id |
| [READ-ONLY] global identification | |
| kerio::web::KId | domainId |
| [REQUIRED FOR CREATE] ID of domain where user belongs to | |
| kerio::web::KId | companyContactId |
| ID of company contact associated with this user. | |
| string | loginName |
| [REQUIRED FOR CREATE] [USED BY QUICKSEARCH] loginName name | |
| string | fullName |
| [USED BY QUICKSEARCH] | |
| string | description |
| [USED BY QUICKSEARCH] | |
| boolean | isEnabled |
| user account is enabled/disabled | |
| DataSource | itemSource |
| is user stored internally or by LDAP? This field cannot be used with Or queries. | |
| UserAuthType | authType |
| supported values must be retrieved from engine by ServerInfo::getSupportedAuthTypes() | |
| string | password |
| [WRITE-ONLY] | |
| boolean | isPasswordReversible |
| typically triple DES | |
| boolean | allowPasswordChange |
| if it is set to false the password can be changed only by the administrator | |
| boolean | hasDefaultSpamRule |
| now: available only on user creation | |
| UserRight | role |
| user role | |
| UserRight | groupRole |
| the mightiest user role obtained via group membership | |
| UserRight | effectiveRole |
| the mightiest user role from role and groupRole | |
| boolean | isWritableByMe |
| Does caller have right to change the user? E.g. if Account Admin gets User structure for Full Admin, isWritableByMe will be false. This field is read-only and cannot be used in kerio::web::SearchQuery conditions. | |
| UserEmailAddressList | emailAddresses |
| List of user email addresses. His default one (loginName) is not listed here. | |
| EmailForwarding | emailForwarding |
| email forwarding setting | |
| UserGroupList | userGroups |
| groups membership | |
| ItemCountLimit | itemLimit |
| max. number of items | |
| kerio::web::SizeLimit | diskSizeLimit |
| max. disk usage | |
| long | consumedItems |
| current items used | |
| kerio::web::ByteValueWithUnits | consumedSize |
| current disk usage | |
| boolean | hasDomainRestriction |
| user can send/receive from/to his/her domain only | |
| kerio::web::SizeLimit | outMessageLimit |
| limit of outgoing message | |
| LastLogin | lastLoginInfo |
| information about last login datetime and protocol | |
| boolean | publishInGal |
| publish user in global address list? Default is true - the user will be published in Global Address Book. | |
| CleanOut | cleanOutItems |
| Items clean-out settings. | |
| IdEntity | accessPolicy |
| ID and name of Access Policy applied for user. Only ID is writable. | |
| HomeServer | homeServer |
| [WRITE-ONCE] Id of user's homeserver if server is in a distributed domain. | |
| kerio::web::OptionalEntity | migration |
| [READ-ONLY] migration.enabled is true if user's store is just being migrated and migration.id contains migration task id | |
User details.
| IdEntity kerio::jsonapi::admin::User::accessPolicy |
ID and name of Access Policy applied for user. Only ID is writable.
| boolean kerio::jsonapi::admin::User::allowPasswordChange |
if it is set to false the password can be changed only by the administrator
| UserAuthType kerio::jsonapi::admin::User::authType |
supported values must be retrieved from engine by ServerInfo::getSupportedAuthTypes()
| CleanOut kerio::jsonapi::admin::User::cleanOutItems |
Items clean-out settings.
| kerio::web::KId kerio::jsonapi::admin::User::companyContactId |
ID of company contact associated with this user.
| long kerio::jsonapi::admin::User::consumedItems |
current items used
| kerio::web::ByteValueWithUnits kerio::jsonapi::admin::User::consumedSize |
current disk usage
| string kerio::jsonapi::admin::User::description |
[USED BY QUICKSEARCH]
| kerio::web::SizeLimit kerio::jsonapi::admin::User::diskSizeLimit |
max. disk usage
| kerio::web::KId kerio::jsonapi::admin::User::domainId |
[REQUIRED FOR CREATE] ID of domain where user belongs to
| UserRight kerio::jsonapi::admin::User::effectiveRole |
the mightiest user role from role and groupRole
| UserEmailAddressList kerio::jsonapi::admin::User::emailAddresses |
List of user email addresses. His default one (loginName) is not listed here.
| EmailForwarding kerio::jsonapi::admin::User::emailForwarding |
email forwarding setting
| string kerio::jsonapi::admin::User::fullName |
[USED BY QUICKSEARCH]
| UserRight kerio::jsonapi::admin::User::groupRole |
the mightiest user role obtained via group membership
| boolean kerio::jsonapi::admin::User::hasDefaultSpamRule |
now: available only on user creation
| boolean kerio::jsonapi::admin::User::hasDomainRestriction |
user can send/receive from/to his/her domain only
| HomeServer kerio::jsonapi::admin::User::homeServer |
[WRITE-ONCE] Id of user's homeserver if server is in a distributed domain.
| kerio::web::KId kerio::jsonapi::admin::User::id |
[READ-ONLY] global identification
| boolean kerio::jsonapi::admin::User::isEnabled |
user account is enabled/disabled
| boolean kerio::jsonapi::admin::User::isPasswordReversible |
typically triple DES
| boolean kerio::jsonapi::admin::User::isWritableByMe |
Does caller have right to change the user? E.g. if Account Admin gets User structure for Full Admin, isWritableByMe will be false. This field is read-only and cannot be used in kerio::web::SearchQuery conditions.
| ItemCountLimit kerio::jsonapi::admin::User::itemLimit |
max. number of items
| DataSource kerio::jsonapi::admin::User::itemSource |
is user stored internally or by LDAP? This field cannot be used with Or queries.
| LastLogin kerio::jsonapi::admin::User::lastLoginInfo |
information about last login datetime and protocol
| string kerio::jsonapi::admin::User::loginName |
[REQUIRED FOR CREATE] [USED BY QUICKSEARCH] loginName name
| kerio::web::OptionalEntity kerio::jsonapi::admin::User::migration |
[READ-ONLY] migration.enabled is true if user's store is just being migrated and migration.id contains migration task id
| kerio::web::SizeLimit kerio::jsonapi::admin::User::outMessageLimit |
limit of outgoing message
| string kerio::jsonapi::admin::User::password |
[WRITE-ONLY]
| boolean kerio::jsonapi::admin::User::publishInGal |
publish user in global address list? Default is true - the user will be published in Global Address Book.
| UserRight kerio::jsonapi::admin::User::role |
user role
| UserGroupList kerio::jsonapi::admin::User::userGroups |
groups membership
