UnitySignOn.idl

Go to the documentation of this file.

/**
 * @file   UnitySignOn.idl
 * @brief  Settings for Kerio Directory
 * @copyright Copyright © 2017 Kerio Technologies
 */

#import <kerio/web/idl/SharedStructures.idl>

module kerio {
module web {

struct SignOn {
   boolean isEnabled;
   string hostName;     ///< Hostname to the Kerio Unity Sign On server. Non default port can be added Eg: example.com:4444
   string userName;     ///< Administrator username
   string password;     ///< [WRITE-ONLY] Administrator password
};

interface UnitySignOn {

   /**
    * Obtain Kerio Unity Sign On settings
    *
    * @param settings - Sign On settings 
    */
   void get(out SignOn settings);

   /**
    * Set Kerio Unity Sign On settings
    *
    * @param settings - Sign On settings 
    */
   void set(in SignOn settings);

   /**
    * Test connection to Kerio Unity Sign On server
    *
    * @param errors - error messages list; If no error is listed, connection is successful
    * @param hostNames - directory server (primary and secondary if any)
    * @param credentials - authentication information
    */
   void testConnection(out ErrorList errors, in StringList hostNames, in Credentials credentials);
};

}; };//end of namespace