Cisco Cisco Security Manager 4.11 User Guide
Cisco Security Manager 4.11 API Specification (Version 2.3)
Page 38
Figure 12: LoginRequest XML Schema
2.2.2.2 Response
The Login API validates the user credentials and returns a session token as a secure cookie. The session value is
stored under the “asCookie” key. This session has a default session inactivity timeout of 15 minutes. An example of
the HTTP Header and XML content response is shown in figure below. The fields in these messages are described
in table below.
stored under the “asCookie” key. This session has a default session inactivity timeout of 15 minutes. An example of
the HTTP Header and XML content response is shown in figure below. The fields in these messages are described
in table below.
serviceVersion will be 2.0 for the config Service:
Figure 13: login Response Example
Table 12: login Response Elements and Attributes Description
HTTP/XML Response
Definition
HTTP Header: asCookie
A cookie defining the authentication string, expiration date, path and domain
that must be passed in all subsequent method calls
e.g. Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010
23:59:59 GMT; path=/; domain=.hostdomain.com
that must be passed in all subsequent method calls
e.g. Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010
23:59:59 GMT; path=/; domain=.hostdomain.com
XML Element: loginResponse
XML content that returns the session information or failure
serviceVersion
The service version of the Configuration service that is running. This attribute is
included only if the user is successfully authenticated.
included only if the user is successfully authenticated.
<xs:element
name
="loginRequest"
type
="LoginRequest"/>
<xs:complexType
name
="
LoginRequest
">
<xs:complexContent>
<xs:extension
base
="
BaseReqResp
">
<xs:sequence>
<xs:element name="
username
" type="
xs:string
" minOccurs="
1
" maxOccurs="
1
"/>
<xs:element name="
password
" type="
xs:string
" minOccurs="
1
" maxOccurs="
1
"/>
<xs:element
name
="heartbeatRequested"
type
="xs:boolean"
minOccurs
="0"
maxOccurs
="1"/>
<xs:element
name
="callbackUrl"
type
="xs:string"
minOccurs
="0"
maxOccurs
="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
HTTP Header:
Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010 23:59:59 GMT; path=/;
domain=.hostdomain.com
XML Content:
<?xml version=”1.0” encoding=”UTF-8”?>
<loginResponse>
Set-Cookie: asCookie=732423sdfs73242; expires=Fri, 31-Dec-2010 23:59:59 GMT; path=/;
domain=.hostdomain.com
XML Content:
<?xml version=”1.0” encoding=”UTF-8”?>
<loginResponse>
<protVersion>1.0</protVersion>
<serviceVersion>1.0.1</serviceVersion>
<sessionTimeoutInMins>15<sessionTimeoutInMins>
<serviceVersion>1.0.1</serviceVersion>
<sessionTimeoutInMins>15<sessionTimeoutInMins>
</loginResponse>