Note
You are viewing the documentation for an older release of Interworx (7.8). To see documentation for the current generally available release of Interworx, click here: 7.13.
Controller: /siteworx/users¶
- Required Permissions
USERS
Action: activate
¶
- Added in Version
4.8.0-393
- Description
Activates a SiteWorx user.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
Action: add
¶
- Added in Version
4.7.0-339
- Description
Add a siteworx user.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No |
|||
|
string |
Yes |
|||
|
string |
No* |
y, n |
n |
“y” if the password is ALREADY encrypted, “n” if the password is not yet encrypted. Default: n |
|
string |
Yes |
|||
|
string |
Yes |
Confirm the password field by providing it again. Must match the password provided. |
||
|
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. |
|
|
string |
No* |
cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh |
en-us |
|
|
string |
No |
|||
|
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”] |
|
|
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¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete a siteworx user.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
Yes |
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit a siteworx user.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
|||
|
string |
No |
Example User |
||
|
string |
No* |
|||
|
string |
No* |
cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh |
en-us |
|
|
string |
No |
|||
|
string |
No* |
y, n |
n |
“y” if the password is ALREADY encrypted, “n” if the password is not yet encrypted. Default: n |
|
string |
No |
|||
|
string |
No |
Confirm the password field by providing it again. Must match the password provided. |
||
|
struct (string) |
No |
EMAIL, FTP |
Sync updated password with default ftp account, postmaster, and/or default shell user. |
|
|
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¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => '[email protected]',
1 => 'Example User ([email protected])',
),
1 =>
array (
0 => '[email protected]',
1 => 'SW Secondary User ([email protected])',
),
),
'reply_code' => 205,
)
Action: listDeletable
¶
- Added in Version
4.7.0-339
- Description
List deletable SiteWorx users.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => '[email protected]',
1 => 'SW Secondary User ([email protected])',
),
),
'reply_code' => 205,
)
Action: listEditable
¶
- Added in Version
4.7.0-339
- Description
List editable SiteWorx users.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
0 => '[email protected]',
1 => 'Example User ([email protected])',
),
1 =>
array (
0 => '[email protected]',
1 => 'SW Secondary User ([email protected])',
),
),
'reply_code' => 205,
)
Action: listMasterUser
¶
- Added in Version
4.7.0-339
- Description
Get details of the working user.
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'userid' => 1,
'nickname' => 'Example User',
'email' => '[email protected]',
'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¶
array (
'status' => 0,
'payload' =>
array (
0 =>
array (
'global_uid' => 'sw1',
'email' => '[email protected]',
'user' => '[email protected]',
'nickname' => 'Example User',
'language' => 'en-us',
'user_status' => 'active',
'type' => 'master',
'ssh_enabled' => '0',
'ssh_username' => 'example_0',
'crypt_password' => '$6$Xxx7Pp7vfsdxkPhu$UjdT2fMVDJ0cdWbdN1eAvHe4YxeziLPCvcuQJpyDURn3TWAljNQEJM3MuDIu7eJLVJ5eOP5EshF/aNO80JUuA0',
),
1 =>
array (
'global_uid' => 'sw2',
'email' => '[email protected]',
'user' => '[email protected]',
'nickname' => 'SW Secondary User',
'language' => 'en-us',
'user_status' => 'active',
'type' => 'slave',
'ssh_enabled' => '0',
'ssh_username' => 'example_1',
'crypt_password' => '$6$uzA6IMKd7HGlKNQZ$Li1aHV2FVqLqncmJTrFyF9/x7ivvVXqoo8pkca2BUGQ2xNpcmLpB.U9M9khvYpOTWq19X7MlqZRJI3vTURoOn0',
),
),
'reply_code' => 205,
)
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' => 'Example User',
'email' => '[email protected]',
'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¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'user_id' => '1',
'nickname' => 'Example User',
'email' => '[email protected]',
'language' => 'en-us',
'menu_style' => NULL,
'encrypted' => 'n',
'password' => NULL,
'confirm_password' => NULL,
'reset_passwords' =>
array (
),
'requires_password_change' => '',
'locked_domains' => NULL,
'user' => '[email protected]',
'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.