HP OneView REST API Reference

sessions
sessions.html[10/17/2013 10:36:07 AM]
Updated: October 16, 2013 4:22
MDT
API Specifications Create Read Update Delete
/rest/sessions GET
/rest/sessions/idle-timeout POST GET
/rest/sessions/users GET
Resource Model
SessionCreate
Session
SessionIdleTimeout
SessionReference
SessionUserList
SessionUser
HP OneView REST API Reference
sessions
The sessions resource manager provides REST APIs to create unique session identifiers, retrieve the session identifiers,
and delete the session identifiers. It also provides APIs to configure session timeouts, update session access time, and
session reference counts. Session identifiers are used across the CI architecture to associate attribute information with a
user or a service. This information is used for numerous purposes, most significantly for authorization and auditing. The
session resource manager is responsible for maintaining session information for both user and trusted component
sessions. The session manager provides access to other components to verify the validity of a session identifier. The
authentication service assigns a new user session identifier to each user upon successful login to the appliance. User
session identifiers are used to submit tasks, check authorizations and track actions throughout the life cycle of login
sessions. Trusted session identifiers are used by resource managers and trusted components to establish and support a
trusted relationship between components. This trust relationship allows the component to carry out privileged operations on
behalf of the user.
URI: /rest/sessions
Method API
GET Gets the user session. It also provides option to update session access time.
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"
Response Description
Session Returns the session
Response Codes
REST API Response Codes
Examples
REQUEST-TYPE: GET
URI: https://{appl}/rest/sessions
Request Header Parameters:
"Session-ID" : The session identifier [required]
"Session-KeepAlive" : The option to reset the session