kerio::jsonapi::admin::Users Interface Reference

import "Users.idl";

Public Member Functions
void	activate (out kerio::web::ErrorList errors, in kerio::web::KIdList userIds)
void	activateOnServer (out kerio::web::ErrorList errors, in kerio::web::KIdList userIds, in kerio::web::KId homeServerId)
void	connectFromExternalService (out boolean result, in string service, in string connectionId, in string clientIpAddress, in long port, in boolean isSecure)
void	authenticateConnectionFromExternalService (out AuthResult result, in string userName, in string password, in string service, in string connectionId, in boolean isSecure)
void	disconnectFromExternalService (in string service, in string connectionId)
void	cancelWipeMobileDevice (in kerio::web::KId userId, in string deviceId)
void	checkMailboxIntegrity (in kerio::web::KIdList userIds)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in UserList users)
void	createLdap (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in UserList users)
void	exportStatistics (out kerio::web::Download fileDownload, in kerio::web::KIdList userIds, in FileFormatType format)
void	exportToCsv (out kerio::web::Download fileDownload, in string filename, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	get (out UserList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	getContactPublicFolderList (out PublicFolderList publicFolders, in kerio::web::KId domainId)
void	getFromServer (out ImporteeList newUsers, in ImportServer importServer, in kerio::web::KId domainToImport)
void	getMailboxCount (out MailboxCount count)
void	getMobileDeviceList (out kerio::jsonapi::mobile::MobileDeviceList list, out long totalItems, in kerio::web::KId userId, in kerio::web::SearchQuery query)
void	getNotActivated (out ImporteeList newUsers, in kerio::web::KId domainId)
void	getRecoveryDeletedItemsSize (out kerio::web::ErrorList errors, out QuotaUsageList sizeList, in kerio::web::KIdList userIds)
void	getStatistics (out UserStatList list, in kerio::web::KIdList userIds, in kerio::web::SearchQuery query)
void	parseFromCsv (out ImporteeList users, in string fileId, in kerio::web::KId domainToImport)
void	recoverDeletedItems (out kerio::web::ErrorList errors, out ResultTripletList recoveryMessages, in kerio::web::KIdList userIds)
void	remove (out kerio::web::ErrorList errors, in RemovalRequestList requests)
void	removeMobileDevice (in kerio::web::KId userId, in string deviceId)
void	resetBuddyList (in kerio::web::KIdList userIds)
void	getEffectiveUserRights (out kerio::web::ErrorList errors, out EffectiveUserRightsList result, in kerio::web::KIdList userIds)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList userIds, in User pattern)
void	wipeMobileDevice (in kerio::web::KId userId, in string deviceId)
void	getPersonalContact (out kerio::web::ErrorList errors, out kerio::jsonapi::contacts::PersonalContactList contacts, in kerio::web::KIdList userIds)
void	setPersonalContact (out kerio::web::ErrorList errors, in kerio::web::KIdList userIds, in kerio::jsonapi::contacts::PersonalContact contact)

Detailed Description

User accounts management.

Member Function Documentation

void kerio::jsonapi::admin::Users::activate	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	userIds
	)

Activate user(s) from a directory service.

Parameters

errors	- list of error messages for appropriate users
userIds	- list of global user identifiers

void kerio::jsonapi::admin::Users::activateOnServer	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	userIds,
		in kerio::web::KId	homeServerId
	)

Activate user(s) from a directory service in distributed domain environment.

Parameters

errors	- list of error messages for appropriate users
userIds	- list of global user identifiers
homeServerId	- Id of server in distributed domain on which users will be activated

void kerio::jsonapi::admin::Users::authenticateConnectionFromExternalService	(	out AuthResult	result,
		in string	userName,
		in string	password,
		in string	service,
		in string	connectionId,
		in boolean	isSecure
	)

Authenticate given user and create session. connectionId must be registered by function connectFromExternalService otherwise authenticate fails.

Parameters

result	- resut of autentication.
userName	- login name + domain name (can be omitted if primary) of the user to be logged in, e.g. "jdoe" or "jdoe@company.com"
password	- password of the user to be authenticate (base64-encoded)
connectionId	- connection identifier, must be the same as in connectFromExternalService
isSecure	- ssl connection

void kerio::jsonapi::admin::Users::cancelWipeMobileDevice	(	in kerio::web::KId	userId,
		in string	deviceId
	)

Cancel wiping of user's mobile device.

Parameters

userId	- global user identifier
deviceId	- ID of user's mobile device to cancel wipe

void kerio::jsonapi::admin::Users::checkMailboxIntegrity

(

in kerio::web::KIdList

userIds

)

Check integrity of all folders in user(s) mailboxes. If corrupted folder is found, try to fix it.

Parameters

userIds

- list of user identifiers

void kerio::jsonapi::admin::Users::connectFromExternalService	(	out boolean	result,
		in string	service,
		in string	connectionId,
		in string	clientIpAddress,
		in long	port,
		in boolean	isSecure
	)

Register connection.

Parameters

service	- service name (should be some real service ID, returned by Services.get)
connectionId	- unique connection identifier
port	- host port
isSecure	- ssl connection

void kerio::jsonapi::admin::Users::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in UserList	users
	)

Create new users.

Parameters

errors	- error message list
result	- list of IDs of created users
users	- new user entities

void kerio::jsonapi::admin::Users::createLdap	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in UserList	users
	)

Create new users in directory service

Parameters

errors	- error message list
result	- list of IDs of created users
users	- new user entities

void kerio::jsonapi::admin::Users::disconnectFromExternalService	(	in string	service,
		in string	connectionId
	)

Unregister connection registered by connectFromExternalService and destroy session created if authenticateFromExternalService was called.

Parameters

service	- service name
connectionId	- unique connection identifier

void kerio::jsonapi::admin::Users::exportStatistics	(	out kerio::web::Download	fileDownload,
		in kerio::web::KIdList	userIds,
		in FileFormatType	format
	)

Export statistics of given users in given format.

Parameters

fileDownload	- description of output file
userIds	- list of IDs of given users
format	- output data format

void kerio::jsonapi::admin::Users::exportToCsv	(	out kerio::web::Download	fileDownload,
		in string	filename,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Export given domain users to comma-separated values file format.

Parameters

fileDownload	- description of output file
filename	- part of filename; full filename is compound as user_<domainname>_<filename>_<date>.csv
query	- query attributes and limits
domainId	- domain identification

void kerio::jsonapi::admin::Users::get	(	out UserList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Obtain a list of users in given domain.

Parameters

list	- users
totalItems	- number of users found in given domain
query	- query attributes and limits
domainId	- domain identification

void kerio::jsonapi::admin::Users::getContactPublicFolderList	(	out PublicFolderList	publicFolders,
		in kerio::web::KId	domainId
	)

Obtain a list of contact public folders in given domain.

Parameters

publicFolderList	- list of public folders
domainId	- global identification of domain

void kerio::jsonapi::admin::Users::getEffectiveUserRights	(	out kerio::web::ErrorList	errors,
		out EffectiveUserRightsList	result,
		in kerio::web::KIdList	userIds
	)

Obtains user effective rights (inherited from groups)

Parameters

errors	- list of users failed to get effective rights
result	- list of effective rights
userIds	- list of IDs of users

void kerio::jsonapi::admin::Users::getFromServer	(	out ImporteeList	newUsers,
		in ImportServer	importServer,
		in kerio::web::KId	domainToImport
	)

Obtain list of users from given LDAP server potentially importable to the Connect server.

Parameters

newUsers	- list of users
importServer	- properties of the server to import from
domainToImport	- the mailserver domain where users are imported

void kerio::jsonapi::admin::Users::getMailboxCount

(

out MailboxCount

count

)

Obtain the number of users created on the server and number of active mailboxes. This method may take a long time if a directory service for mapped users is not available.

Parameters

count

- Number of users created on the server and number of active mailboxes.

void kerio::jsonapi::admin::Users::getMobileDeviceList	(	out kerio::jsonapi::mobile::MobileDeviceList	list,
		out long	totalItems,
		in kerio::web::KId	userId,
		in kerio::web::SearchQuery	query
	)

Obtain a list of mobile devices of given user.

Parameters

list	- mobile devices of given user
totalItems	- number of mobile devices found for given user
userId	- name of user
query	- query attributes and limits

void kerio::jsonapi::admin::Users::getNotActivated	(	out ImporteeList	newUsers,
		in kerio::web::KId	domainId
	)

Obtain a list of LDAP mapped users who are not activated in given domain. Only user's ID, loginName, fullName, description are set in structures.

Parameters

newUsers	- list of users
domainId	- global identification of domain

void kerio::jsonapi::admin::Users::getPersonalContact	(	out kerio::web::ErrorList	errors,
		out kerio::jsonapi::contacts::PersonalContactList	contacts,
		in kerio::web::KIdList	userIds
	)

Get personal user contacts

void kerio::jsonapi::admin::Users::getRecoveryDeletedItemsSize	(	out kerio::web::ErrorList	errors,
		out QuotaUsageList	sizeList,
		in kerio::web::KIdList	userIds
	)

Obtain a size of items stored for recovering.

Parameters

errors	- error message list
sizes	- count and size of items
userIds	- global identification of user

void kerio::jsonapi::admin::Users::getStatistics	(	out UserStatList	list,
		in kerio::web::KIdList	userIds,
		in kerio::web::SearchQuery	query
	)

Obtain statistics of given users.

Parameters

list	- users' statistics
userIds	- list of IDs of given users
query	- query parameters and limits

void kerio::jsonapi::admin::Users::parseFromCsv	(	out ImporteeList	users,
		in string	fileId,
		in kerio::web::KId	domainToImport
	)

Parse users from given string. It is used to import users from file. The only supported encoding is UTF-8.

Parameters

users	- list of parsed users with appropriate status and message
fileId	- ID of the uploaded file
domainToImport	- import to given domain, magic constants 'PRIMARY_DOMAIN': use primary domain 'PRESERVE_FROM_CSV': preserve domain from CSV file (use primary if not defined)

void kerio::jsonapi::admin::Users::recoverDeletedItems	(	out kerio::web::ErrorList	errors,
		out ResultTripletList	recoveryMessages,
		in kerio::web::KIdList	userIds
	)

Recover deleted items for particular user(s). If the user quota is exceeded an error with code 4000 will be returned.

Parameters

recoveryMessages	- list of recovery messages
userIds	- list of user IDs
recoverAnyway	- if true messages are recovered even if the user quota is exceeded.

void kerio::jsonapi::admin::Users::remove	(	out kerio::web::ErrorList	errors,
		in RemovalRequestList	requests
	)

Remove user(s).

Parameters

errors	- list of users failed to remove only (successfully removed are NOT listed)
requests	- list of user IDs to be removed, method, and owner of deleted messages

void kerio::jsonapi::admin::Users::removeMobileDevice	(	in kerio::web::KId	userId,
		in string	deviceId
	)

Remove mobile device from the list of user's mobile devices.

Parameters

userId	- name of user
deviceId	- ID of user's mobile device to be removed

void kerio::jsonapi::admin::Users::resetBuddyList

(

in kerio::web::KIdList

userIds

)

IM: Reset buddy list of selected users

Parameters

userIds

- list of user identifiers

void kerio::jsonapi::admin::Users::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	userIds,
		in User	pattern
	)

Set users' details according given pattern.

Parameters

errors	- create a new user
userIds	- list of IDs of users to be changed
pattern	- pattern to use for new values

void kerio::jsonapi::admin::Users::setPersonalContact	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	userIds,
		in kerio::jsonapi::contacts::PersonalContact	contact
	)

Set personal user contacts

void kerio::jsonapi::admin::Users::wipeMobileDevice	(	in kerio::web::KId	userId,
		in string	deviceId
	)

Wipe user's mobile device.

Parameters

userId	- global user identifier
deviceId	- ID of user's mobile device to be wiped

---

The documentation for this interface was generated from the following file:

• Users.idl