| The Cube Panelīs API 2.2 Reference Guide: Accessing Cube Panel's WebServices | ||
|---|---|---|
| Prev | Chapter 2. API Reference Guide | Next |
Input parameters:
- [username] : string : name of restricted user
- password : string : password of restricted user
- comment : string : user comments
Output parameters:
- Returns a integer with the ID of the new user if it has been created correctly
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_CREATEUSER
- ERROR_RESTDIRS_USERNAMEEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Create a restricted user for using it with web directory restrictions.
- If the username is null, an auto-generated sequential name will be assigned.
Examples:
.NET Java PHP
Input parameters:
- userId : int : restricted user ID
- newPassword : string : new password to assign
Output parameters:
- Returns a boolean with true value if the password has been changed correctly
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_RESTDIRS_CHANGEUSERPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Assign a new password to the restricted user associated with the ID userId.
Examples:
.NET Java PHP
Input parameters:
- arrayUserId : Array : array of restricted user ID.
Output parameters:
- Returns a boolean with true value if the users have been deleted correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_RESTDIRS_REMOVEUSER
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Delete the restricted users indicated in the array arrayUserId.
Examples:
.NET Java PHP
Input parameters:
- [searchUser] : string : filter the search by restricted user name
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfRestrictedUserInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTUSERS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Lists existing restricted users for the domain accessing the web service.
- The results may be ordered by the following criteria:
- name : name of restricted user
Examples:
.NET Java PHP
Input parameters:
- groupName : string : name of group to create
- comment : string : group comments
Output parameters:
- Return a boolean with true value if the group has been created correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GROUPEXISTS
- ERROR_RESTDIRS_CREATEGROUP
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Create an empty group of restricted users.
Examples:
.NET Java PHP
Input parameters:
- arrayGroupId : Array : array of restricted group IDs.
Output parameters:
- Return a boolean with true value if groups have been deleted correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GROUPIDNOTEXISTS
- ERROR_RESTDIRS_REMOVEGROUP
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Delete the groups indicated in the array arrayGroupId.
Examples:
.NET Java PHP
Input parameters:
- [searchGroup] : string : filter the search by name of restricted group
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfRestrictedGroupInfoSimple
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTGROUPS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Lists the groups of existing restricted users for the domain accessing the web service.
- The results may be ordered by the following criteria:
- name : group name
- users : number of restricted users in the group
Examples:
.NET Java PHP
Input parameters:
- groupId : int : group ID
- arrayUserId : Array : array of restricted user IDs to be added to the group.
Output parameters:
- Returns a boolean with true value if users have been added correctly to the group.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GROUPIDNOTEXISTS
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_RESTDIRS_USERALREADYINGROUP
- ERROR_RESTDIRS_ADDUSERTOGROUP
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Add the restricted users indicated in the array arrayUserId to the group groupId.
Examples:
.NET Java PHP
Input parameters:
- groupId : int : group ID.
- arrayUserId : Array : array of IDs of restricted users to be deleted from the group.
Output parameters:
- Return a boolean with true value if the users have been deleted correctly from the group.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GROUPIDNOTEXISTS
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_RESTDIRS_USERNOTINGROUP
- ERROR_RESTDIRS_REMOVEUSERFROMGROUP
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Delete the users indicated in the array arrayUserId to the group groupId.
Examples:
.NET Java PHP
Input parameters:
- dirName : string : name of directory restriction
- path : string : directory to restrict (relative to the domain's web directory)
Output parameters:
- Return a boolean with true value if the restriction has been created correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_DIREXISTS
- ERROR_RESTDIRS_CREATEDIR
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Create a restriction without any group associated to a web directory.
Examples:
.NET Java PHP
Input parameters:
- dirId : int : restricted directory ID.
- arrayGroupId : Array : array of group IDs to be added.
Output parameters:
- Returns a boolean with true value if the groups have been added to the directory correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_DIRIDNOTEXISTS
- ERROR_RESTDIRS_GROUPIDNOTEXISTS
- ERROR_RESTDIRS_GROUPALREADYINDIR
- ERROR_RESTDIRS_ADDGROUPTODIRECTORYRESTRICTION
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Authorize the groups indicated in the array arrayGroupId to access the restricted directory dirId.
Examples:
.NET Java PHP
Input parameters:
- dirId : int : restricted directory ID.
- arrayGroupId : Array : array of IDs of the groups to delete from the restricted directory.
Output parameters:
- Returns a boolean with true value if the groups have been deleted from the directory correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_DIRIDNOTEXISTS
- ERROR_RESTDIRS_GROUPIDNOTEXISTS
- ERROR_RESTDIRS_GROUPNOTINDIRECTORY
- ERROR_RESTDIRS_REMOVEGROUPFROMDIRECTORY
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Remove the authorization of the groups indicated in the array arrayGroupId to access the restricted directory dirId.
Examples:
.NET Java PHP
Input parameters:
- arrayDirId : Array : array of directory IDs.
Output parameters:
- Return a boolean with true value if have been deleted from the directory correctly.
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_DIRIDNOTEXISTS
- ERROR_RESTDIRS_UNRESTRICTDIRECTORY
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Delete the restriction of the directories indicated in the array arrayDirId.
Examples:
.NET Java PHP
Input parameters:
- [searchDir] : string : filter the search by restriction name
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfRestrictedDirInfoSimple
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTRESTRICTEDDIRS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- List the existing restricted user groups for the domain accessing the web service.
- The results may be ordered by the following criteria:
- name : name of restriction
- path : restriction directory
- groups : number of groups authorized in the restriction
Examples:
.NET Java PHP
Input parameters:
- groupId : int : group ID
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfRestrictedUserInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTGROUPUSERS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- List the users in the group groupId.
Examples:
.NET Java PHP
Input parameters:
- dirId : int : directory ID
- [orderArray] : OrderArray : results order structure
Output parameters:
- Returns an ArrayOfRestrictedGroupInfoSimple
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTDIRGROUPS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- List the groups authorized to access the restricted directory dirId.
Examples:
.NET Java PHP
Input parameters:
- userId : int : restricted user ID
Output parameters:
- Returns a RestrictedUserInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GETUSERINFO
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Obtain the username and password of a restricted user.
Examples:
.NET Java PHP
Input parameters:
- groupId : int : group ID.
Output parameters:
- Returns a RestrictedGroupInfo
- Or fault:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GETGROUPINFO
- ERROR_RESTDIRS_GROUPNOTEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Callable by: domain
Necessary permissions: PERM_DOMAIN_HOSTING
Remarks:
- Obtain the name, comments and number of users of the group groupId.
Examples:
.NET Java PHP