Users and Roles - UserSession Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/{SessionKey}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: user-session
A UserSession object contains information about a currently-authenticated user in the Sentinel system.
FieldDescription
addressThe IP address of the client system from which the user authenticated.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
nameThe username of the account that is authenticated to the Sentinel system.
os-nameThe username of the associated account on the client operation system. May not be present.
session-typeThe type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection.
startThe starting date and time of the user session.
userThe URL of the Sentinel User object associated with the session object.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/Wildebeest
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"user-session",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/Wildebeest"
   },
   "session-type":"Wildebeest",
   "start":"2012-04-25T13:33:44.727Z",
   "address":"Wildebeest",
   "name":"Wildebeest",
   "os-name":"Wildebeest"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: user-session
A UserSession object contains information about a currently-authenticated user in the Sentinel system.
FieldRequiredDescription
addressfalseThe IP address of the client system from which the user authenticated.
namefalseThe username of the account that is authenticated to the Sentinel system.
os-namefalseThe username of the associated account on the client operation system. May not be present.
session-typefalseThe type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection.
startfalseThe starting date and time of the user session.
userfalseThe URL of the Sentinel User object associated with the session object.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/Wildebeest
{
   "session-type":"Wildebeest",
   "start":"2012-04-25T13:33:44.727Z",
   "address":"Wildebeest",
   "name":"Wildebeest",
   "os-name":"Wildebeest"
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/Wildebeest