| Referencia de la API 2.2 de Cube Panel: Acceso a los servicios web de Cube Panel | ||
|---|---|---|
| Anterior | Capítulo 2. Referencia de la API | Siguiente |
Parámetros de entrada:
- [username] : string : nombre del usuario restringido
- password : string : contraseña del usuario restringido
- comment : string : comentario del usuario
Parámetros de salida:
- Devuelve un entero con el identificador del nuevo usuario si se ha creado correctamente.
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_CREATEUSER
- ERROR_RESTDIRS_USERNAMEEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Crea un usuario restringido para su uso con restricciones de directorio web.
- Si username es null, se usará un nombre secuencial autogenerado.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- userId : int : identificador de usuario restringido
- newPassword : string : nueva contraseña a asignar
Parámetros de salida:
- Devuelve un boolean a true si la contraseña se ha cambiado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_RESTDIRS_CHANGEUSERPASSWORD
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Asigna una nueva contraseña al usuario restringido asociado al identificador userId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- arrayUserId : Array : array de identificadores de usuarios restringidos
Parámetros de salida:
- Devuelve un boolean a true si los usuarios han sido eliminados correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_RESTDIRS_REMOVEUSER
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Elimina los usuarios restringidos indicados en el array arrayUserId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [searchUser] : string : filtra la búsqueda por nombre de usuario restringido
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfRestrictedUserInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTUSERS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Lista los usuarios restringidos existentes para el dominio que invoca al servicio web
- El resultado puede ser ordenado por los siguientes criterios:
- name : nombre de usuario restringido
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- groupName : string : nombre del grupo a crear
- comment : string : comentario del grupo
Parámetros de salida:
- Devuelve un boolean a true si el grupo se ha creado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GROUPEXISTS
- ERROR_RESTDIRS_CREATEGROUP
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Crea un nuevo grupo vacio de usuarios restringidos.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- arrayGroupId : Array : array de identificadores de grupos restringidos
Parámetros de salida:
- Devuelve un boolean a true si los grupos se han eliminado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GROUPIDNOTEXISTS
- ERROR_RESTDIRS_REMOVEGROUP
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Elimina los grupos indicados en el array arrayGroupId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [searchGroup] : string : filtra la búsqueda por nombre de grupo restringido
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfRestrictedGroupInfoSimple
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTGROUPS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Lista los grupos de usuarios restringidos existentes para el dominio que invoca al servicio web
- El resultado puede ser ordenado por los siguientes criterios:
- name : nombre de grupo
- users : número de usuarios restringidos pertenecientes al grupo
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- groupId : int : identificador de grupo
- arrayUserId : Array : array de identificadores de usuarios restringidos a añadir al grupo
Parámetros de salida:
- Devuelve un boolean a true si los usuarios se han añadido correctamente al grupo
- O un fallo:
- 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
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Añade los usuarios indicados en el array arrayUserId al grupo groupId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- groupId : int : identificador de grupo
- arrayUserId : Array : array de identificadores de usuarios restringidos a eliminar del grupo
Parámetros de salida:
- Devuelve un boolean a true si los usuarios se han eliminado del grupo correctamente al grupo
- O un fallo:
- 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
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Elimina los usuarios indicados en el array arrayUserId al grupo groupId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- dirName : string : nombre de restricción sobre un directorio
- path : string : directorio a restringir (relativo al directorio web del dominio)
Parámetros de salida:
- Devuelve un boolean a true si la restricción se ha creado correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_DIREXISTS
- ERROR_RESTDIRS_CREATEDIR
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Crea una restricción sin ningún grupo asociado sobre un directorio web.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- dirId : int : identificador del directorio restringido
- arrayGroupId : Array : array de identificadores de grupos a añadir a la restricción
Parámetros de salida:
- Devuelve un boolean a true si los grupos se han añadido al directorio correctamente
- O un fallo:
- 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
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Autoriza a los grupos indicados en el array arrayGroupId a acceder al directorio restringido dirId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- dirId : int : identificador del directorio restringido
- arrayGroupId : Array : array de identificadores de los grupos a eliminar de la restricción
Parámetros de salida:
- Devuelve un boolean a true si los grupos se han eliminado del directorio correctamente
- O un fallo:
- 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
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Quita la autorización a los grupos indicados en el array arrayGroupId a acceder al directorio restringido dirId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- arrayDirId : Array : array de identificadores de directorios
Parámetros de salida:
- Devuelve un boolean a true si los grupos se han eliminado del directorio correctamente
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_DOMAIN_LOCKED
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_DIRIDNOTEXISTS
- ERROR_RESTDIRS_UNRESTRICTDIRECTORY
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Elimina la restricción de los directorios indicados en el array arrayDirId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- [searchDir] : string : filtra la búsqueda por nombre de restricción
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfRestrictedDirInfoSimple
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTRESTRICTEDDIRS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Lista los grupos de usuarios restringidos existentes para el dominio que invoca al servicio web
- El resultado puede ser ordenado por los siguientes criterios:
- name : nombre de restricción
- path : directorio de la restricción
- groups : número de grupos autorizados en la restricción
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- groupId : int : identificador del grupo
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfRestrictedUserInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTGROUPUSERS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Lista los usuarios pertenecientes al grupo groupId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- dirId : int : identificador del directorio
- [orderArray] : OrderArray : estructura de ordenación de resultados
Parámetros de salida:
- Devuelve un ArrayOfRestrictedGroupInfoSimple
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_LISTDIRGROUPS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Lista los grupos autorizados a acceder al directorio restringido dirId.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- userId : int : identificador de usuario restringido
Parámetros de salida:
- Devuelve un RestrictedUserInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GETUSERINFO
- ERROR_RESTDIRS_USERIDNOTEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Obtiene el usuario y contraseña de un usuario restringido.
Ejemplos:
.NET Java PHP
Parámetros de entrada:
- groupId : int : identificador de grupo
Parámetros de salida:
- Devuelve un RestrictedGroupInfo
- O un fallo:
- ERROR_PROCESSOR_USERAUTH
- ERROR_PROCESSOR_PARAM_VALIDATION
- ERROR_RESTDIRS_GETGROUPINFO
- ERROR_RESTDIRS_GROUPNOTEXISTS
- ERROR_PROCESSOR_CONNECT_SYSTEM_DATABASE
Invocable por: domain
Permisos necesarios: PERM_DOMAIN_HOSTING
Funcionamiento:
- Obtiene el nombre, comentario y número de usuarios del grupo groupId.
Ejemplos:
.NET Java PHP