Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
Certificate-
based
authentication
allowed
If the common name in the client certificate matches a username in the device configuration file,
the API request is allowed access with the privileges assigned to that username. Messages do
not need username and password values, which are ignored if present.
If the common name does not match a username, all messages must include valid username
and password values.
Certificate-
based
authentication
required
Any username and password fields in the messages are always ignored. If the common name in
the client certificate matches a username in the device configuration file, the API request is
logged in with the privileges assigned to that username. If the common name does not match a
username, the API request is rejected.
Message flow
The application initiates the communication and sends a correctly formatted XML-RPC command to the
device.
Example command
<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
<methodName>recording.delete</methodName>
<params>
<param>
<value>
<struct>
<member>
<name>authenticationPassword</name>
<value><string></string></value>
</member>
<member>
<name>recordingId</name>
<value><int>101</int></value>
</member>
<member>
<name>authenticationUser</name>
<value><string>admin</string></value>
</member>
</struct>
</value>
</param>
</params>
</methodCall>
Assuming the command was well formed, and that the device is responsive, the device will respond in one of
these ways:
n
With an XML methodResponse message that may or may not contain data, depending on the command.
n
With an XML methodResponse that includes only a fault code message.
Example success
<?xml version="1.0"?>
<methodResponse>
Cisco TelePresence MCU API 2.10
Page 9 of 296
Overview
Message flow