Authentication.idl

Go to the documentation of this file.

/**
 * @file     Authentication.idl
 * @brief    API for authentication
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>
 
module webadmin {
 
struct HttpProxyAuth {
   boolean enabled;
   kerio::web::OptionalEntity addressGroup;
};
 
struct Radius {
   boolean         enabled;
   Password        password;
   IdReference    certificate;
};

struct GuestConfig {
   kerio::web::OptionalString         password;
   string      message;
};

struct AuthenticationConfig {
   boolean authenticationRequired;
   boolean ntlmEnabled;
   HttpProxyAuth httpProxyAuth;
   Radius radius;
   GuestConfig guest;
   kerio::web::OptionalLong inactivityTimeout; ///< in minutes
};

struct TotpConfig {
   boolean required;
   boolean remoteConfig;
};

enum JoinStatus {
  JoinStatusConnected,
  JoinStatusDisconnected,
  JoinStatusError
};

interface Authentication {

   /**
    * Returns Authetication option settings
    * @param config - configuration values
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void get(out AuthenticationConfig config);
   
   /**
    * Stores Authetication option settings
    * @param config - configuration values
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void set(in AuthenticationConfig config);
   
   /**
    * joins computer to domain
    * @param message - text related to join result
    * @param status - current status
    * @param hostName - name of the computer that will be set to computer and in domain controller
    * @param domainName - domain name (e.g. example.com)
    * @param credentials - domain account with rights to join the domain
    * @param server - server name (e.g. server.example.com) - filled only in case, that joinNeedServer returns true
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void join(out kerio::web::LocalizableMessage message, out JoinStatus status, in string hostName, in string domainName, in CredentialsConfig credentials, in string server);
  
   /**
    * tests, if join's param server need to be filled
    * @param needServer - true - join must have param server.enabled on true and server.value filled
    * @param domainName - domain name (e.g. example.com)
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void isJoinServerNeeded(out boolean needServer, in string domainName);

   /**
    * disconnects computer from domain
    * @param message - text related to leave result
    * @param status - current status    
    * @param credentials - domain account with rights to leave from domain
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void leave(out kerio::web::LocalizableMessage message, out JoinStatus status, in CredentialsConfig credentials);
  
   /**
    * tests if computer is joined to domain
    * @param status - current status
    * @param domainName - a string representation of joined domain.
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void getJoinStatus(out JoinStatus status, out string domainName);
   
   /**
    * Returns TotpConfig
    * @param config - configuration values
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void getTotpConfig(out TotpConfig config);

   /**
    * Stores TotpConfig
    * @param config - configuration values
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void setTotpConfig(in TotpConfig config);

};

}; //webadmin