Validate a user login.
Function: UsersValidateLogin (parameter1, parameter2, parameter3, parameter4)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| UserName |
String |
The name of the user to be added. |
| UserPassword |
String |
The password of the user to be added. |
Returns: UserDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| UserDetails |
User_Details |
Details of the user, as defined in the User_Details class. |
Add a new user for a given user name.
Function: UsersAdd (parameter1, parameter2, parameter3)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| User |
User_Details |
Details of the user, as defined in the User_Details class. |
Returns: UserDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| UserDetails |
User_Details |
Details of the User, as defined in the User_Details class. |
Edit a user for a given user name.
Function: UsersEdit (parameter1, parameter2, parameter3)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| UserDetails |
User_Details |
Details of the user, as defined in the User_Details class. |
Returns: UserDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| UserDetails |
User_Details |
Details of the User, as defined in the User_Details class. |
Delete a user for a given user name.
Function: UsersDelete (parameter1, parameter2, parameter3)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| UserName |
String |
The name of the user to be deleted. |
Returns: UserDeleteInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
Find a user for a given user name.
Function: UsersFind (parameter1, parameter2, parameter3)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
| UserName |
String |
The name of the user to be found. |
Returns: UserDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| UserDetails |
User_Details |
Details of the user, as defined in the User_Details class. |
List reseller’s users.
Function: UsersList (parameter1, parameter2)
|
Input Parameter
|
Type
|
Description
|
| UserApiKey |
String |
User with permissions to call this web service. |
| UserApiPassword |
String |
User’s password of the user used in UserApiKey parameter. |
Returns: UserListWithDetailsInfoResult
|
Field
|
Type
|
Description
|
| Message |
String |
A text message explaining the results of the operation, including the reason for any failures. |
| Result |
Boolean |
Returns true if the function call was successful. |
| Result_Code |
Int32 |
A result code, which differs by function. |
| UsersDetails |
User_Details[] |
A list of users with details, as defined in the User_Details class. Those assigned to the reseller. |
Object - User_Details
|
Field
|
Type
|
Description
|
| User_Name |
String |
The name of the user. |
| User_Password |
String |
The encrypted password of the user.
Note: if left blank, it will NOT be changed in the database.
|
| Email_Address |
String |
The email address of the user.
Note: if left blank, it will be changed to NULL in the database.
|
| Whmcs_Client_Id |
Int64 |
The whmcs client ID of the user.
Note: if left blank, it will be changed to NULL in the database.
|