User's Manual

418 | Administration Dell Networking W-ClearPass Guest 6.4 | User Guide
Name Type Description
uid Integer ID of the guest account to delete
delete_account Flag Set to 0 to disable the guest account,
1 to delete the guest account
Return Values
This function might return a Boolean false value if some input parameters are invalid.
Name Type Description
error Flag Set to 1 if the guest account was not
deleted
message String Message describing the success or
failure of the operation
item Struct User structure containing updated
field values
uid Integer ID of the guest account
*_error String Field-specific error message
*_error_flag Flag Field-specific error flag, set to 1 if
present
Access Control
Requires the remove_account privilege (Guest Manager > Remove Accounts in the Operator Profile
Editor).
Example Usage
Sample parameters for the call:
'uid' => '162',
'delete_account' => '0',
Result returned by a successful operation:
'error' => 0,
'message' => 'Disabled guest account ',
'item' =>
array (
'id' => 162,
'enabled' => 0,
'username' => '',
),
Result returned by a failed operation:
'uid' => 162,
'username' => '',
'expiration_time' => '',
'user_enabled' => '',
'delete_account_error' => 'Please choose from one of these options.',
'delete_account_error_flag' => 1,
'error' => 1,