HP OneView REST API Reference

login-sessions
login-sessions.html[10/17/2013 10:36:04 AM]
Updated: October 16, 2013 3:57
MDT
API Specifications Create Read Update Delete
/rest/login-sessions POST PUT DELETE
/rest/login-sessions/schema GET
Resource Model
LoginSessionId
LoginInfo
HP OneView REST API Reference
login-sessions
Authentication service provides REST APIs to login, reconnect to an existing session, and terminate a session (logout). The
login API returns a session token on successful authentication. The reconnect and logout REST APIs require a session
token in the request header.
URI: /rest/login-sessions
Method API
POST Authenticates a user with specified credentials. The user name, password and an optional
directory are specified as input in request body.
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Request
Body
Attributes Description
LoginInfo Required Login credentials
Response Description
LoginSessionId Returns a valid session token on success. Returns
an error message on failure.
Response Codes
REST API Response Codes
Examples
POST https://{appl}/rest/login-sessions
The following example authenticates user, administrator from directory,
mydirectory.
https://example.com/rest/login-sessions
{
"userName":"administrator",
"password":"mypassword",
"authLoginDomain":"mydirectory"
}
The following example authenticates user, administrator from default
directory.
https://example.com/rest/login-sessions
{
"userName":"administrator",