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

Method amigopod.guest.create

Page 12 highlights

amigopod XMLRPC Interface Version 0.9 Method amigopod.guest.create Create a new guest account. Parameters Name Type Description sponsor_name String Name of the person sponsoring the guest account visitor_name String Name of the visitor visitor_company String Company name of the visitor email String The visitor's email address. This will become their username to log into the network expire_after Numeric Amount of time before the account will expire. Specified in hours expire_time String Optional date and time at which the account will expire role_id Integer RADIUS Role ID to assign to the account creator_accept_terms Flag Set to 1 to indicate acceptance of the service's terms of use * * Other fields as specified by create_user form customization Return Values Name error id password *_error *_error_flag Type Flag Integer String String Flag Description Set to 1 if the account was not created Set to the ID of the guest account if the account was created Set to a randomly generated value (default behaviour only) Field-specific error message Field-specific error flag, set to 1 if present Access Control Requires the create_user privilege (Guest Manager Account). Create New Guest Example Usage Sample parameters for call: 'sponsor_name' => 'Sponsor Name', 'visitor_name' => 'Visitor Name', 'visitor_company' => 'Visitor Company', 'email' => '[email protected]', CONFIDENTIAL 12

  • 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
12
Method amigopod.guest.create
Create a new guest account.
Parameters
Name
Type
Description
sponsor_name
String
Name of the person sponsoring the
guest account
visitor_name
String
Name of the visitor
visitor_company
String
Company name of the visitor
email
String
The visitor’s email address. This will
become their username to log into the
network
expire_after
Numeric
Amount of time before the account will
expire. Specified in hours
expire_time
String
Optional date and time at which the
account will expire
role_id
Integer
RADIUS Role ID to assign to the
account
creator_accept_terms
Flag
Set to 1 to indicate acceptance of the
service’s terms of use
*
*
Other fields as specified by
create_user
form customization
Return Values
Name
Type
Description
error
Flag
Set to 1 if the account was not created
id
Integer
Set to the ID of the guest account if the
account was created
password
String
Set to a randomly generated value
(default behaviour only)
*_error
String
Field-specific error message
*_error_flag
Flag
Field-specific error flag, set to 1 if present
Access Control
Requires the
create_user
privilege (Guest Manager
±
Create New Guest
Account).
Example Usage
Sample parameters for call:
'sponsor_name' => 'Sponsor Name',
'visitor_name' => 'Visitor Name',
'visitor_company' => 'Visitor Company',
'email' => '[email protected]',