kerio::jsonapi::admin::Groups Interface Reference

import "Groups.idl";

Public Member Functions
void	activate (out kerio::web::ErrorList errors, in kerio::web::KIdList groupIdList)
void	addMemberList (out kerio::web::ErrorList errors, in kerio::web::KId groupId, in kerio::web::KIdList userList)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in GroupList groups)
void	createLdap (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in GroupList groups)
void	get (out GroupList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	remove (out kerio::web::ErrorList errors, in GroupRemovalRequestList requests)
void	removeMemberList (out kerio::web::ErrorList errors, in kerio::web::KId groupId, in kerio::web::KIdList userIds)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList groupIds, in Group pattern)

Detailed Description

Group management

Member Function Documentation

void kerio::jsonapi::admin::Groups::activate	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	groupIdList
	)

Activate groups from a directory service

Parameters

errors	- list of error messages for appropriate groups
userIdList	- list of global groups identifiers

void kerio::jsonapi::admin::Groups::addMemberList	(	out kerio::web::ErrorList	errors,
		in kerio::web::KId	groupId,
		in kerio::web::KIdList	userList
	)

Add new member(s) to a group.

Parameters

errors	- error message list
groupId	- global group identifier
userList	- list of global identifiers of users to be added to a group

void kerio::jsonapi::admin::Groups::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in GroupList	groups
	)

Create new groups.

Parameters

errors	- error message list
result	- list of IDs of created groups
groups	- new group entities

void kerio::jsonapi::admin::Groups::createLdap	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in GroupList	groups
	)

Create new groups in directory service.

Parameters

errors	- error message list
result	- list of IDs of created groups
groups	- new group entities

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

Obtain a list of groups.

Parameters

list	- groups
totalItems	- amount of groups for given search condition, useful when limit is defined in searchquery
query	- query conditions and limits
domainName	- domain identification

void kerio::jsonapi::admin::Groups::remove	(	out kerio::web::ErrorList	errors,
		in GroupRemovalRequestList	requests
	)

Remove groups.

Note: it is not necessary to remove members before deleting a group

Parameters

errors	- error message list
groupIds	- list of global identifiers of group(s) to be deleted

void kerio::jsonapi::admin::Groups::removeMemberList	(	out kerio::web::ErrorList	errors,
		in kerio::web::KId	groupId,
		in kerio::web::KIdList	userIds
	)

Remove member(s) from a group.

Parameters

errors	- error message list
groupId	- global group identifier
userIds	- list of global identifiers of users to be add to a group

void kerio::jsonapi::admin::Groups::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	groupIds,
		in Group	pattern
	)

Create a new group.

Parameters

errors	- error message list
groupIds	- a list group global identifier(s)
pattern	- pattern to use for new values

---

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

• Groups.idl