Specifications

B-11
Cisco NAC Appliance - Clean Access Manager Configuration Guide
OL-28003-01
Appendix B API Support
User Operations
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0; another <!--list=iplist--> comment with an IP list and session time
remaining for each IP entry
• Failure: error string
renewuserstime
The renewuserstime function renews the logged-in In-Band users session timeout by a session.
Required In Parameters:
• op: renewuserstime
• list: Specifies a comma-separated list of IP addresses. Supported format: 10.1.10.10, 10.1.10.11,
10.1.10.12
Note If you do not use session-based authentication, the admin and passwd arguments are required. See
Authentication Requirements, page B-2.
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0
• Failure: error string
changeuserrole
The changeuserrole function changes In-Band user access permissions for a logged-in user by removing
the user from the Online Users list and adding the user’s MAC address to the Device Filters list with a
new role.
Required In Parameters:
• op: changeuserrole
• ip: Specifies the IP address of a user who is logged in.
• role: Specifies the role to which the user is to be moved.
Note If you do not use session-based authentication, the admin and passwd arguments are required. See
Authentication Requirements, page B-2.
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0
• Failure: error string
changeloggedinuserrole
The changeloggedinuserrole function changes access permissions for a logged-in In-Band user by
changing that user’s current role to a new role.