Public Member Functions | |
| void | get (out kerio::web::ErrorList warnings, out UserList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId) |
| void | create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in UserList users, in kerio::web::KId domainId) |
| void | set (out kerio::web::ErrorList errors, in kerio::web::KIdList userIds, in User details, in kerio::web::KId domainId) |
| void | remove (out kerio::web::ErrorList errors, in kerio::web::KIdList userIds, in kerio::web::KId domainId) |
| void | convertLocalUsers (in kerio::web::KId domainId) |
| void | getAdUsers (out UserList users, in string domainName, in string server, in CredentialsConfig credentials, in boolean ldapSecure) |
| void | getNtUsers (out UserList users, in string domainName) |
| void | getSupportedLanguages (out kerio::web::NamedValueList languages) |
| void | getMySettings (out UserSettings settings) |
| void | setMySettings (in UserSettings settings) |
| void | checkWarnings (out kerio::web::ErrorList errors, in User user) |
| void webadmin::Users::checkWarnings | ( | out kerio::web::ErrorList | errors, |
| in User | user | ||
| ) |
Checks, if autoLogin and vpnAddress params are unique and returns appropriate warnings if so
| errors | - list of all warnings |
| user | - user data |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::convertLocalUsers | ( | in kerio::web::KId | domainId | ) |
replace all conflicting local users with domain users in policies
| domainId | - id of domain - specifies domain, from which users will be loaded |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::create | ( | out kerio::web::ErrorList | errors, |
| out kerio::web::CreateResultList | result, | ||
| in UserList | users, | ||
| in kerio::web::KId | domainId | ||
| ) |
Add new user
| errors | - list of errors 1000 Operation failed. - "Unable to add item." 1001 Already exists. - "User %1 already exists." 8001 Invalid params. - "Unable to add/modify user %1, wrong parameters." 8002 Database error. - "Unable to add/modify user %1, it may already exist." |
| result | - list of IDs assigned to each item |
| users | - details for new users. field id is assigned by the manager to temporary value until apply() or reset(). |
| domainId | - id of domain - specifies domain, where user will be created (only local is supported) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::get | ( | out kerio::web::ErrorList | warnings, |
| out UserList | list, | ||
| out long | totalItems, | ||
| in kerio::web::SearchQuery | query, | ||
| in kerio::web::KId | domainId | ||
| ) |
Obtain list of users in given domain
| warnings | - list of warnings 8003 Users conflict. - "Some user names are in conflict with users in the local user database." 8004 Authentication Error. - "Some user accounts are not functional, authentication in the directory service and/or Windows NT® domain is not active." |
| list | - list of users and it's details |
| totalItems | - count of all users on server (before the start/limit applied) |
| query | - conditions and limits |
| domainId | - id of domain - only users from this domain will be listed |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1000 Operation failed. - "Directory service error: %1." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::getAdUsers | ( | out UserList | users, |
| in string | domainName, | ||
| in string | server, | ||
| in CredentialsConfig | credentials, | ||
| in boolean | ldapSecure | ||
| ) |
Returns list of users suitable for import
| users | - list of users and details |
| domainName | - name of AD domain |
| server | - AD server |
| credentials | - username and password for user with read privilegies |
| ldapSecure | - use secured connection |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1000 Operation failed. - "Directory service error: %1." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::getMySettings | ( | out UserSettings | settings | ) |
Returns list of user's settings
| settings | - list of all settings |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::getNtUsers | ( | out UserList | users, |
| in string | domainName | ||
| ) |
Returns list of users suitable for import
| users | - list of users and details |
| domainName | - name of NT domain |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1000 Operation failed. - "Failed to list Windows NT domain users, error: %1." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::getSupportedLanguages | ( | out kerio::web::NamedValueList | languages | ) |
supported languages, name like "Cestina" in utf8, value in configuration, default value is "detect"
| languages | - list of languages |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::remove | ( | out kerio::web::ErrorList | errors, |
| in kerio::web::KIdList | userIds, | ||
| in kerio::web::KId | domainId | ||
| ) |
Delete users
| errors | - list of errors 1000 Operation failed. - "Unable to remove item." 1000 Operation failed. - "Unable to delete Admin user." 8002 Database error. - "Unable to delete the user." |
| userIds | - ids of users that should be removed |
| domainId | - id of domain - specifies domain, where user will be removed (only local is supported) |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::set | ( | out kerio::web::ErrorList | errors, |
| in kerio::web::KIdList | userIds, | ||
| in User | details, | ||
| in kerio::web::KId | domainId | ||
| ) |
Update users' details
| errors | - list of errors 1001 Already exists. - "User %1 already exists." 8001 Invalid params. - "Unable to add/modify user %1, wrong parameters." 8002 Database error. - "Unable to add/modify user %1, it may already exist." |
| userIds | - ids of users to be updated. |
| details | - details for update. Field "kerio::web::KId" is ignored. Only filled details will be stored in users config defined by userIds |
| domainId | - id of domain - users from this domain will be updated |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
| void webadmin::Users::setMySettings | ( | in UserSettings | settings | ) |
Stores list of user's settings
| settings | - list of all settings |
| kerio::web::ApiException | -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." |
