Cisco Cisco Security Manager 4.11 User Guide
Cisco Security Manager 4.11 API Specification (Version 2.3)
Page 39
HTTP/XML Response
Definition
sessionTimeoutInMins
The session timeout in minutes is the amount of minutes that must pass with no
activity by the client before the CSM server discards the session as no longer
active. Any access by the CSM client after a session has been timed out will be
rejected and require the client to re-authenticate to gain access to the CSM
server again. This attribute is only included if the user is successfully
authenticated. Default is 15 minutes.
activity by the client before the CSM server discards the session as no longer
active. Any access by the CSM client after a session has been timed out will be
rejected and require the client to re-authenticate to gain access to the CSM
server again. This attribute is only included if the user is successfully
authenticated. Default is 15 minutes.
Figure 14: LoginResponse XML Schema Method heartbeatCallback
An example of the Method heartbeatCallback is shown below. The fields in these messages are described in the
table below.
table below.
Figure 15: Method heartbeatCallback Example
Table 13: Method heartbeatCallback Elements and Attributes Description
HTTP Header/XML
Argument
Argument
Definition
heartbeatCallbackRequest
The heatbeatCallback method is called by the CSM Server on the CSM client to
ensure the csm client is still active
ensure the csm client is still active
HTTP Method
POST
HTTP Header: asCookie
The cookie returned by the login method that identifies the authentication
session
session
<xs:element
name
="loginResponse"
type
="LoginResponse"/>
<xs:complexType
name
="
LoginResponse
">
<xs:complexContent>
<xs:extension
base
="
BaseReqResp
">
<xs:sequence>
<xs:element
name
="serviceVersion"
type
="xs:string"
minOccurs
="1"
maxOccurs
="1"/>
<xs:element
name
="sessionTimeoutInMins"
type
="xs:positiveInteger"
minOccurs
="1"
maxOccurs
="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
URL:
https://csm-clienthost/heartbeatCallback
HTTP Header:
Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010 23:59:59 GMT; path=/;
domain=.hostdomain.com
XML Argument:
<?xml version=”1.0” encoding=”UTF-8”?>
<heartbeatCallbackRequest>
https://csm-clienthost/heartbeatCallback
HTTP Header:
Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010 23:59:59 GMT; path=/;
domain=.hostdomain.com
XML Argument:
<?xml version=”1.0” encoding=”UTF-8”?>
<heartbeatCallbackRequest>
<protVersion>1.0</protVersion>
</heartbeatCallbackRequest>