Controller: /siteworx/users =========================== :Required Permissions: USERS Action: ``activate`` -------------------- :Added in Version: 4.8.0-393 :Description: Activates a SiteWorx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - sw_second@interworx.com - - Action: ``add`` --------------- :Added in Version: 4.7.0-339 :Description: Add a siteworx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``nickname`` - string - No - - - * - ``email`` - string - Yes - - - * - ``encrypted`` - string - No* - y, n - n - "y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n * - ``password`` - string - Yes - - - * - ``confirm_password`` - string - Yes - - - Confirm the password field by providing it again. Must match the password provided. * - ``requires_password_change`` - integer - No - 1 - - If selected, the next time this user logs in via the web, they will be forced to change their password before doing anything else. * - ``language`` - string - No* - cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh - en-us - * - ``menu_style`` - string - No - - - * - ``perms`` - struct (string) - No - OVERVIEW, LOGIN, EMAIL, STATS, FTP, LOGS, MYSQL, BACKUP, SUBDOMAINS, PREFERENCES, USERS, FILEMANAGER, POINTERDOMS, CRONTAB, SSL, HTACCESS, SLAVEDOMS, RUBYONRAILS, DNS, PHP, HTTPAUTH, MAILMAN, softaculous - ["LOGIN"] - * - ``locked_domains`` - string - No - - - Users may be locked to a subset of domains. This field is a comma separated list of domains, and may additionally use the negation operator (!) and the wildcard (\*). \* indicates that it's actually required, but probably already has a valid default value. Action: ``deactivate`` ---------------------- :Added in Version: 4.8.0-393 :Description: Deactivates (but does not delete) a SiteWorx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - sw_second@interworx.com - - Action: ``delete`` ------------------ :Added in Version: 4.7.0-339 :Description: Delete a siteworx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - sw_second@interworx.com - - Action: ``edit`` ---------------- :Added in Version: 4.7.0-339 :Description: Edit a siteworx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - string - Yes - user@example.com, sw_second@interworx.com - - * - ``nickname`` - string - No - - Example User - * - ``email`` - string - No* - - user@example.com - * - ``language`` - string - No* - cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh - en-us - * - ``menu_style`` - string - No - - - * - ``encrypted`` - string - No* - y, n - n - "y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n * - ``password`` - string - No - - - * - ``confirm_password`` - string - No - - - Confirm the password field by providing it again. Must match the password provided. * - ``reset_passwords`` - struct (string) - No - EMAIL, FTP - - Sync updated password with default ftp account, postmaster, and/or default shell user. * - ``requires_password_change`` - integer - No - 1 - - If selected, the next time this user logs in via the web, they will be forced to change their password before doing anything else. \* indicates that it's actually required, but probably already has a valid default value. Action: ``fail`` ---------------- :Added in Version: n/a :Description: Magic function - test for failure mechanism. Action: ``list`` ---------------- :Added in Version: 4.7.0-339 :Description: List SiteWorx users. .. warning:: This action has been deprecated as of version 4.8.0-393. 2011-01-27 use ListUsersAction Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'user@example.com', 1 => 'Example User (user@example.com)', ), 1 => array ( 0 => 'sw_second@interworx.com', 1 => 'SW Secondary User (sw_second@interworx.com)', ), ), 'reply_code' => 205, ) Action: ``listDeletable`` ------------------------- :Added in Version: 4.7.0-339 :Description: List deletable SiteWorx users. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'sw_second@interworx.com', 1 => 'SW Secondary User (sw_second@interworx.com)', ), ), 'reply_code' => 205, ) Action: ``listEditable`` ------------------------ :Added in Version: 4.7.0-339 :Description: List editable SiteWorx users. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'user@example.com', 1 => 'Example User (user@example.com)', ), 1 => array ( 0 => 'sw_second@interworx.com', 1 => 'SW Secondary User (sw_second@interworx.com)', ), ), 'reply_code' => 205, ) Action: ``listMasterUser`` -------------------------- :Added in Version: 4.7.0-339 :Description: Get details of the working user. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'userid' => 1, 'nickname' => 'Example User', 'email' => 'user@example.com', 'ismaster' => true, 'status' => 'active', 'language' => 'en-us', 'theme' => 'interworx', 'menu_style' => 'small', 'config' => array ( ), 'requires_password_change' => '', 'perms' => array ( 0 => 'MASTER', ), 'ssh_enabled' => '0', 'ssh_username' => 'example_0', 'ssh_public_key' => '', ), 'reply_code' => 205, ) Action: ``listUsers`` --------------------- :Added in Version: 4.8.0-393 :Description: List SiteWorx users. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'global_uid' => 'sw1', 'email' => 'user@example.com', 'user' => 'user@example.com', 'nickname' => 'Example User', 'language' => 'en-us', 'user_status' => 'active', 'type' => 'master', 'ssh_enabled' => '0', 'ssh_username' => 'example_0', 'crypt_password' => '$6$kjlJCfEbpMxun1Z6$ZsbTCg7ANV/caa1usghgdbt2bnl3KGOSv4K2Y0alxkWI1yMzBl3abxjLJLP.I4tZo1gTzvcHTK.Qe3zjlaq1u.', ), 1 => array ( 'global_uid' => 'sw2', 'email' => 'sw_second@interworx.com', 'user' => 'sw_second@interworx.com', 'nickname' => 'SW Secondary User', 'language' => 'en-us', 'user_status' => 'active', 'type' => 'slave', 'ssh_enabled' => '0', 'ssh_username' => 'example_1', 'crypt_password' => '$6$kjlJCfEbpMxun1Z6$ZsbTCg7ANV/caa1usghgdbt2bnl3KGOSv4K2Y0alxkWI1yMzBl3abxjLJLP.I4tZo1gTzvcHTK.Qe3zjlaq1u.', ), ), 'reply_code' => 205, ) Action: ``listWorkingUser`` --------------------------- :Added in Version: 4.7.0-339 :Description: Get details of the working user. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'userid' => 1, 'nickname' => 'Example User', 'email' => 'user@example.com', 'ismaster' => true, 'status' => 'active', 'language' => 'en-us', 'theme' => 'interworx', 'menu_style' => 'small', 'config' => array ( ), 'requires_password_change' => '', 'perms' => array ( 0 => 'MASTER', ), 'ssh_enabled' => '0', 'ssh_username' => 'example_0', 'ssh_public_key' => '', ), 'reply_code' => 205, ) Action: ``queryEdit`` --------------------- :Added in Version: 6.0.25-1415 :Description: Displays the information available to the action "edit". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - string - Yes - user@example.com, sw_second@interworx.com - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'user_id' => '1', 'nickname' => 'Example User', 'email' => 'user@example.com', 'language' => 'en-us', 'menu_style' => NULL, 'encrypted' => 'n', 'password' => NULL, 'confirm_password' => NULL, 'reset_passwords' => array ( ), 'requires_password_change' => '', 'locked_domains' => NULL, 'user' => 'user@example.com', 'password1' => NULL, 'password2' => NULL, ), 'reply_code' => 205, ) Action: ``reroute`` ------------------- :Added in Version: n/a :Description: Action to re-route from the current controller to a different one. Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.