Chapter 58: Controller: /nodeworx/updates Up Part II: NodeWorx API Spec Part III: SiteWorx API Spec 

59 Controller: /nodeworx/users

Required Permissions "NODEWORXUSER"
Action: activate
Added in version 4.8.0-393
Description Activates a NodeWorx user.
Input Parameters
Name Type Notes Required?
user struct (string) Example Values
second@interworx.com
Yes
Action: add
Added in version 4.7.0-339
Description Add a new nodeworx user.
Input Parameters
Name Type Notes Required?
nickname string No*
email string No*
language string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
encrypted string Description
"y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n
Example Values
y, n
Example Default Value
n
No*
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
perms struct (string) Example Values
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
Example Default Value
["LOGIN"]
No
* 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
Name Type Notes Required?
user struct (string) Example Values
second@interworx.com
Yes
Action: delete
Added in version 4.7.0-339
Description Delete a nodeworx user.
Input Parameters
Name Type Notes Required?
user struct (string) Example Values
second@interworx.com
Yes
Action: edit
Added in version 4.7.0-339
Description Edit a user.
Input Parameters
Name Type Notes Required?
user string Example Values
apidocs@interworx.com, second@interworx.com
Yes
nickname string Example Default Value
Server Admin
No*
email string Example Default Value
apidocs@interworx.com
No*
language string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
encrypted string Description
"y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n
Example Values
y, n
Example Default Value
n
No*
password string No
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
No
* indicates that it’s actually required, but probably already has a valid default value
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
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)’,
),
),
)
Action: listDeletable
Added in version 4.7.0-339
Description List deletable NodeWorx users.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’second@interworx.com’,
1 => ’NW Secondary User (second@interworx.com)’,
),
),
)
Action: listEditable
Added in version 4.7.0-339
Description List editable NodeWorx users.
Sample output
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)’,
),
),
)
Action: listMasterUser
Added in version 4.7.0-339
Description Get details of the master user.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’userid’ => 1,
’nickname’ => ’Server Admin’,
’email’ => ’nodeworx_user@example.com’,
’ismaster’ => true,
’status’ => ’active’,
’language’ => ’en-us’,
’theme’ => ’calliope’,
’menu_style’ => ’big’,
’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’,
),
),
)
Action: listUsers
Added in version 4.8.0-393
Description List NodeWorx users.
Sample output
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’ => ’nw208’,
’email’ => ’second@interworx.com’,
’nickname’ => ’NW Secondary User’,
’language’ => ’en-us’,
’user_status’ => ’active’,
’type’ => ’slave’,
),
),
)
Action: listWorkingUser
Added in version 4.7.0-339
Description Get details of the working user.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’userid’ => 1,
’nickname’ => ’Server Admin’,
’email’ => ’nodeworx_user@example.com’,
’ismaster’ => true,
’status’ => ’active’,
’language’ => ’en-us’,
’theme’ => ’calliope’,
’menu_style’ => ’big’,
’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’,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
user string Example Values
apidocs@interworx.com, second@interworx.com
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’user_id’ => ’1’,
’nickname’ => ’Server Admin’,
’email’ => ’nodeworx_user@example.com’,
’language’ => ’en-us’,
’theme’ => ’calliope’,
’menu_style’ => ’big’,
’encrypted’ => ’n’,
’password’ => NULL,
’confirm_password’ => NULL,
’user’ => ’nodeworx_user@example.com’,
),
)
 Chapter 58: Controller: /nodeworx/updates Up Part II: NodeWorx API Spec Part III: SiteWorx API Spec 

(C) 2017 by InterWorx LLC