Dell PowerConnect W Clearpass 100 Software XMLRPC Interface TechNote - Page 20

Method amigopod.guest.reset.password

Page 20 highlights

amigopod XMLRPC Interface Version 0.9 Example Usage Sample parameters 'details' => 0, Sample successful call: 'ids' => array ( 0 => '37', 1 => '141', 2 => '40', ... ), Method amigopod.guest.reset.password Reset a guest account's password to a random value. Parameters Name uid Type Integer Description ID of the guest account to reset the password for Return Values Name error message item *_error *_error_flag Type Flag String Struct String Flag Description Set to 1 if the password was not reset Message describing the success or failure of the operation User structure containing updated field values Field-specific error message Field-specific error flag, set to 1 if present Access Control Requires the reset_password privilege (Reset Password). Example Usage Sample parameters for call: 'uid' => 162, Sample successful call: 'error' => 0, 'message' => 'Guest account password reset for Password changed to 37172833', 'item' => array ( 'id' => 162, 'password' => '37172833', 'username' => '', ), CONFIDENTIAL 20

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

amigopod XMLRPC Interface
Version 0.9
CONFIDENTIAL
20
Example Usage
Sample parameters
'details' => 0,
Sample successful call:
'ids' =>
array (
0 => '37',
1 => '141',
2 => '40',
...
),
Method amigopod.guest.reset.password
Reset a guest account’s password to a random value.
Parameters
Name
Type
Description
uid
Integer
ID of the guest account to reset the
password for
Return Values
Name
Type
Description
error
Flag
Set to 1 if the password was not reset
message
String
Message describing the success or
failure of the operation
item
Struct
User structure containing updated field
values
*_error
String
Field-specific error message
*_error_flag
Flag
Field-specific error flag, set to 1 if present
Access Control
Requires the
reset_password
privilege (Reset Password).
Example Usage
Sample parameters for call:
'uid' => 162,
Sample successful call:
'error' => 0,
'message' => 'Guest account password reset for
Password changed to 37172833',
'item' =>
array (
'id' => 162,
'password' => '37172833',
'username' => '',
),