Login
post
/{versionId}/admin/login
Authenticate and establish a user session on the SDM server. A user must establish a valid authenticated session before other method calls can be used. The response to a successful authentication returns a valid time-limited session cookie that needs to be returned with all subsequent REST requests to establish the user has an authenticated session in progress.
Request
Path Parameters
Header Parameters
Back to Top
Response
200 Response
400 Response
The user input is invalid.
401 Response
The user ID or password is invalid.
404 Response
The REST API version of your input request cannot be found.
Examples
Examples of Accessing the API
The following example shows how to login using curl.
curl -X POST \
-c sessionid.txt \
-d@request.xml \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/admin/login"The following example shows how to login using Python.
import requests
from lxml import etree
url = "http://example.com:8080/rest/v1.3/admin/login"
headers = { "Accept":"application/xml", "Content-Type":"application/xml" }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)
# extract the cookie from the response
tree = etree.fromstring(resp.content)
cookie = tree.xpath('//sessionId')[0].text
# add the cookie to the headers dictionary for subsequent requests
headers['Cookie'] = cookieExample of the Request Body
The following example shows the contents of the request body in XML.
<?xml version="1.0" encoding="UTF-8"?>
<session>
<userName>admin</userName>
<password>password</password>
</session>The following example shows the contents of the request body in JSON.
{
"userName": "admin",
"password": "<password>"
}Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<session>
<idleTimeout>0</idleTimeout>
<serverInfo>NNC82</serverInfo>
<sessionId>37366B7ECFF47D540C87705CF7584AD9.tomcat1</sessionId>
<userGroup>administrators</userGroup>
<userName>admin</userName>
<validUntil>valid until logout</validUntil>
</session>The following example shows the contents of the response body in JSON.
{
"idleTimeout": 0,
"serverInfo": "NNC82_5",
"sessionId": "2F42C14157AEA4956E97ED80A755671E.tomcat1",
"userGroup": "administrators",
"userName": "admin",
"validUntil": "valid until logout"
}