AccessPolicy.idl

Go to the documentation of this file.

/**
 * @file   AccessPolicy.idl
 * @brief  Work with user access rules for client protocols.
 * 
 * @author Frantisek Boranek
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

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


module kerio {
module jsonapi {
module admin {

enum ServiceType {
   ServiceActiveSync,   ///< ActiveSync
   ServiceEWS,       ///< EWS
   ServiceIMAP,      ///< IMAP, Kerio Outlook Connector
   ServiceKoff,      ///< Kerio Outlook Connector (Offline Edition)
   ServicePOP3,      ///< POP3
   ServiceWebDAV,    ///< WebDAV, CalDAV, CardDAV
   ServiceWebMail,      ///< WebMail
   ServiceXMPP    ///< XMPP
};

enum AccessPolicyConnectionRuleType {
   ServiceAllowed,      ///< service is allowed
   ServiceDenied,       ///< service is forbidden
   ServiceIpAllowed,    ///< service is allowed for specific IP group
   ServiceIpDenied      ///< service is forbidden for specific IP group
};

struct AccessPolicyConnectionRule {
   AccessPolicyConnectionRuleType type;   ///< type of rule
   kerio::web::KId groupId;            ///< if type of rule is 'ServiceIpAllowed/Denied' there is ID of IP Group
};

/**
 * Access policy rule details.
 */
struct AccessPolicyRule {
   kerio::web::KId id;              ///< [READ-ONLY] [REQUIRED FOR SET] global identification
   kerio::web::KId groupId;         ///< [REQUIRED FOR CREATE] global identification of AccessPolicyGroup
   ServiceType service;          ///< type of service
   AccessPolicyConnectionRule rule; ///< rule for connections
};

/**
 * List of AccessPolicyRule.
 */
typedef sequence<AccessPolicyRule> AccessPolicyRuleList;

struct ServiceTypeInfo {
   ServiceType service; ///< type of service
   string description;     ///< description of service enum
};

typedef sequence<ServiceTypeInfo> ServiceTypeInfoList;


/**
 * Access policy group details.
 */
struct AccessPolicyGroup {
   kerio::web::KId id;        ///< [READ-ONLY] [REQUIRED FOR SET] global identification
   string name;            ///< name of policy
   boolean isDefault;         ///< [READ-ONLY]
};

/**
 * List of AccessPolicy.
 */
typedef sequence<AccessPolicyGroup> AccessPolicyGroupList;


/**
 * Access policies management.
 */
interface AccessPolicy {

   /**
    * Add new policies.
    *
    * @param errors - error message list
    * @param result - list of IDs of created rules
    * @param rules - new policies rules
    */
   void create(out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in AccessPolicyRuleList rules);

   /**
    * Create the list of groups.
    *
    * @param errors - error message list
    * @param result - list of IDs of created groups
    * @param groups - list of groups to create
    */
   void createGroupList(out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in AccessPolicyGroupList groups);

   /**
    * Obtain a list of policies.
    *
    * @param list - policies
    * @param totalItems - number of policies found
    * @param query - query attributes and limits
    */
   void get(out AccessPolicyRuleList list, out long totalItems, in kerio::web::SearchQuery query);

   /**
    * Get the list of groups, sorted in ascending order.
    *
    * @param groups - list of Access policy groups
    */
   void getGroupList(out AccessPolicyGroupList groups);

   /**
    * Get the list of services.
    *
    * @param services - list of service info
    */
   void getServiceList(out ServiceTypeInfoList services);

   /**
    * Remove policies.
    *
    * @param errors - error message list
    * @param ruleIds - list of IDs of policy to be removed
    */
   void remove(out kerio::web::ErrorList errors, in kerio::web::KIdList ruleIds);

   /**
    * Remove the list of groups.
    *
    * @param errors - error message list
    * @param groupIds - list of IDs of group policy to be removed
    */
   void removeGroupList(out kerio::web::ErrorList errors, in kerio::web::KIdList groupIds);

   /**
    * Set policy details.
    *
    * @param errors - error message list
    * @param rules - rules to save
    */
   void set(out kerio::web::ErrorList errors, in AccessPolicyRuleList rules);

   /**
    * Set the list of groups.
    *
    * @param errors - error message list
    * @param groups - list of group to set
    */
   void setGroupList(out kerio::web::ErrorList errors, in AccessPolicyGroupList groups);
};

}; }; };//end of namespace