User's Manual
420 | Administration Dell Networking W-ClearPass Guest 6.4 | User Guide
Return Values
Name Type Description
error Flag Set to 1 if the guest account was not
modified
message String Message describing the success or
failure of the operation
item Struct User structure containing updated
field values
uid Integer IDof 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 full_user_control privilege (Guest Manager >Full User Control in the Operator Profile
Editor).
Example Usage
Sample parameters for the call:
'uid' => 162,
'username' => 'demo@example.com',
'password' => 'password_value',
'password_value' => 'password',
'role_id' => 2,
'enabled' => 1,
'simultaneous_use' => 1,
'do_schedule' => 0,
'schedule_time' => '',
'do_expire' => 4,
'expire_time' => '2014-12-01 00:00:00',
'expire_postlogin' => 0,
Sample successful call:
'error' => 0,
'message' => 'Edited properties of guest account demo@example.com',
'item' =>
array (
'id' => 162,
'username' => 'demo@example.com',
'role_id' => 2,
'enabled' => true,
'simultaneous_use' => 1,
'do_schedule' => 0,
'do_expire' => 4,
'expire_postlogin' => 0,
'role_name' => 'Guest',
'expire_time' => 1196431200,
),
Sample failed call:
'uid' => 162,
'random_password' => '59447116',