API Guide

POST method for Sessions
This method authenticates the user and establishes a session.
Description Authenticates the user and establishes a session.
Privilege SECURITY_SETUP
HTTP response
codes
200
Example request
body
{
"UserName":"root",
"Password":"linux",
"SessionType":"API"
}
Example
response body
{
"Id": "7b723932-a119-4843-a5b7-7a122e4def99",
"Description": "root",
"Name": "API",
"UserName": "root",
"Password": null,
"Roles": [
"ADMINISTRATOR"
],
"IpAddress": "xx.xx.xx.xx",
"StartTimeStamp": "2017-04-17 20:07:12.357",
"LastAccessedTimeStamp": "2017-04-17 20:07:12.357"
}
Table 134. Attributes
Attribute Name Description
UserName The Session user name.
Password The session user password.
SessionType The type of session being created.
Id The unique identifier of the SessionService.
Description Description for the user session.
Name Name of the session.
Roles Role privileges.
IpAddress IP address of session source.
StartTimeStamp Time when the session began.
LastAccessedTimeStamp Time when the session was last accessed.
Session 393