Controller: /nodeworx/users =========================== :Required Permissions: NODEWORXUSER Action: ``activate`` -------------------- :Added in Version: 4.8.0-393 :Description: Activates a NodeWorx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - second@interworx.com - - Action: ``add`` --------------- :Added in Version: 4.7.0-339 :Description: Add a new nodeworx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``nickname`` - string - No* - - - * - ``email`` - string - No* - - - * - ``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 - - - * - ``theme`` - 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 - 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. * - ``perms`` - struct (string) - No - NODEWORXUSER, LANGUAGES, THEMES, SWACCOUNTS, SHELLUSERS, PACKAGES, LOGIN, BRESTORE, IMPORT, EMAIL, RESELLER, APACHE, FTP, MYSQL, DNS, SSH, APIKEY, CRON, IPS, FIREWALL, UPDATES, GRAPHS, NFS, CLUSTERING, SETTINGS, IWORXLOGS, PHPMYADMIN, PLUGINS, SSL, REMOTEASSIST - ["LOGIN"] - \* 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 NodeWorx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - second@interworx.com - - Action: ``delete`` ------------------ :Added in Version: 4.7.0-339 :Description: Delete a nodeworx user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - second@interworx.com - - Action: ``edit`` ---------------- :Added in Version: 4.7.0-339 :Description: Edit a user. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - string - Yes - apidocs@interworx.com, second@interworx.com - - * - ``nickname`` - string - No* - - Server Admin - * - ``email`` - string - No* - - apidocs@interworx.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 - - - * - ``theme`` - 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. * - ``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: ``expirePasswords`` --------------------------- :Added in Version: 6.7.4-1760 :Description: Bulk expire control panel user passwords. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``expire`` - string - Yes - all, nodeworx, siteworx - - Action: ``fail`` ---------------- :Added in Version: n/a :Description: Magic function - test for failure mechanism. Action: ``isReseller`` ---------------------- :Added in Version: 4.7.0-339 :Description: Check if the current user is a reseller or not. Action: ``list`` ---------------- :Added in Version: 4.7.0-339 :Description: List NodeWorx users. .. warning:: This action has been deprecated as of version 4.8.0-393. 2011-01-24 use listUsersAction Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'nodeworx_user@example.com', 1 => 'Server Admin (nodeworx_user@example.com)', ), 1 => array ( 0 => 'second@interworx.com', 1 => 'NW Secondary User (second@interworx.com)', ), ), 'reply_code' => 205, ) Action: ``listDeletable`` ------------------------- :Added in Version: 4.7.0-339 :Description: List deletable NodeWorx users. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'second@interworx.com', 1 => 'NW Secondary User (second@interworx.com)', ), ), 'reply_code' => 205, ) Action: ``listEditable`` ------------------------ :Added in Version: 4.7.0-339 :Description: List editable NodeWorx users. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => 'nodeworx_user@example.com', 1 => 'Server Admin (nodeworx_user@example.com)', ), 1 => array ( 0 => 'second@interworx.com', 1 => 'NW Secondary User (second@interworx.com)', ), ), 'reply_code' => 205, ) Action: ``listMasterUser`` -------------------------- :Added in Version: 4.7.0-339 :Description: Get details of the master user. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'userid' => 1, 'nickname' => 'Server Admin', 'email' => 'nodeworx_user@example.com', 'ismaster' => true, 'status' => 'active', 'language' => 'en-us', 'theme' => 'interworx', 'menu_style' => 'small', 'config' => array ( ), 'requires_password_change' => '', 'perms' => array ( 0 => 'NODEWORXUSER', 1 => 'LANGUAGES', 2 => 'THEMES', 3 => 'SWACCOUNTS', 4 => 'SHELLUSERS', 5 => 'PACKAGES', 6 => 'LOGIN', 7 => 'BRESTORE', 8 => 'IMPORT', 9 => 'EMAIL', 10 => 'RESELLER', 11 => 'APACHE', 12 => 'FTP', 13 => 'MYSQL', 14 => 'DNS', 15 => 'SSH', 16 => 'APIKEY', 17 => 'CRON', 18 => 'IPS', 19 => 'FIREWALL', 20 => 'UPDATES', 21 => 'GRAPHS', 22 => 'NFS', 23 => 'CLUSTERING', 24 => 'SETTINGS', 25 => 'IWORXLOGS', 26 => 'PHPMYADMIN', 27 => 'PLUGINS', 28 => 'SSL', 29 => 'REMOTEASSIST', ), ), 'reply_code' => 205, ) Action: ``listUsers`` --------------------- :Added in Version: 4.8.0-393 :Description: List NodeWorx users. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'global_uid' => 'nw1', 'email' => 'nodeworx_user@example.com', 'nickname' => 'Server Admin', 'language' => 'en-us', 'user_status' => 'active', 'type' => 'master', ), 1 => array ( 'global_uid' => 'nw2', 'email' => 'second@interworx.com', 'nickname' => 'NW Secondary User', 'language' => 'en-us', 'user_status' => 'active', 'type' => 'slave', ), ), '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' => 'Server Admin', 'email' => 'nodeworx_user@example.com', 'ismaster' => true, 'status' => 'active', 'language' => 'en-us', 'theme' => 'interworx', 'menu_style' => 'small', 'config' => array ( ), 'requires_password_change' => '', 'perms' => array ( 0 => 'NODEWORXUSER', 1 => 'LANGUAGES', 2 => 'THEMES', 3 => 'SWACCOUNTS', 4 => 'SHELLUSERS', 5 => 'PACKAGES', 6 => 'LOGIN', 7 => 'BRESTORE', 8 => 'IMPORT', 9 => 'EMAIL', 10 => 'RESELLER', 11 => 'APACHE', 12 => 'FTP', 13 => 'MYSQL', 14 => 'DNS', 15 => 'SSH', 16 => 'APIKEY', 17 => 'CRON', 18 => 'IPS', 19 => 'FIREWALL', 20 => 'UPDATES', 21 => 'GRAPHS', 22 => 'NFS', 23 => 'CLUSTERING', 24 => 'SETTINGS', 25 => 'IWORXLOGS', 26 => 'PHPMYADMIN', 27 => 'PLUGINS', 28 => 'SSL', 29 => 'REMOTEASSIST', ), ), 'reply_code' => 205, ) Action: ``queryEdit`` --------------------- :Added in Version: 5.1.0-838 :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 - apidocs@interworx.com, second@interworx.com - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'user_id' => '1', 'nickname' => 'Server Admin', 'email' => 'nodeworx_user@example.com', 'language' => 'en-us', 'menu_style' => NULL, 'theme' => NULL, 'encrypted' => 'n', 'password' => NULL, 'confirm_password' => NULL, 'requires_password_change' => '', 'user' => 'nodeworx_user@example.com', ), '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.