All Classes Files Functions Variables Enumerations Enumerator Groups Pages
UnitySignOn.idl
Go to the documentation of this file.
1 /**
2  * @file UnitySignOn.idl
3  * @brief Settings for Kerio Directory
4  * @copyright Copyright © 2017 Kerio Technologies
5  */
6 
7 #import <kerio/web/idl/SharedStructures.idl>
8 
9 module kerio {
10 module web {
11 
12 struct SignOn {
13  boolean isEnabled;
14  string hostName; ///< Hostname to the Kerio Unity Sign On server. Non default port can be added Eg: example.com:4444
15  string userName; ///< Administrator username
16  string password; ///< [WRITE-ONLY] Administrator password
17 };
18 
19 interface UnitySignOn {
20 
21  /**
22  * Obtain Kerio Unity Sign On settings
23  *
24  * @param settings - Sign On settings
25  */
26  void get(out SignOn settings);
27 
28  /**
29  * Set Kerio Unity Sign On settings
30  *
31  * @param settings - Sign On settings
32  */
33  void set(in SignOn settings);
34 
35  /**
36  * Test connection to Kerio Unity Sign On server
37  *
38  * @param errors - error messages list; If no error is listed, connection is successful
39  * @param hostNames - directory server (primary and secondary if any)
40  * @param credentials - authentication information
41  */
42  void testConnection(out ErrorList errors, in StringList hostNames, in Credentials credentials);
43 };
44 
45 }; };//end of namespace
46