| Parameter | Type | Default Value | Description |
|---|---|---|---|
query |
string | [no filter] | The TinyQ language filter that specifies a subset of all available records. |
field |
string | not present | The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values, |
page |
integer | 1 | The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize. |
pagesize |
integer | [unlimited] | The maximum number of object records to return as a result of the request. |
| Object type: page | |
|---|---|
| A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing. | |
| Field | Description |
| next | A URL addressing the subsequent page of objects in the total set of available objects. |
| objects | The list of objects returned in the page of results. |
| prev | A URL addressing the previous page of objects in the total set of available objects. |
| Object type: user-session | |
|---|---|
| A UserSession object contains information about a currently-authenticated user in the Sentinel system. | |
| Field | Description |
| address | The IP address of the client system from which the user authenticated. |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| name | The username of the account that is authenticated to the Sentinel system. |
| os-name | The username of the associated account on the client operation system. May not be present. |
| session-type | The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection. |
| start | The starting date and time of the user session. |
| user | The 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. | |
| Field | Description |
| @href | The URL reference to the object. |
| type | The name of the object type |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/user-session?page=2&pagesize=1
{
"objects":[
{
"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.726Z",
"address":"Wildebeest",
"name":"Wildebeest",
"os-name":"Wildebeest"
}
],
"prev":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/user-session?pagesize=1&page=1"
},
"next":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/user-session?pagesize=1&page=3"
}
}
| Object type: user-session | ||
|---|---|---|
| A UserSession object contains information about a currently-authenticated user in the Sentinel system. | ||
| Field | Required | Description |
| address | false | The IP address of the client system from which the user authenticated. |
| name | false | The username of the account that is authenticated to the Sentinel system. |
| os-name | false | The username of the associated account on the client operation system. May not be present. |
| session-type | false | The type of session. May be one of "HTTP" or "LEGACY". "LEGACY" indicates a session with the older, SCC-style client connection. |
| start | false | The starting date and time of the user session. |
| user | false | The 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. | ||
| Field | Required | Description |
| @href | false | The URL reference to the object. |
| type | false | The name of the object type |
| Object type: | |
|---|---|
| The metadata representation of the newly-created user-session object, including the URL reference to the new object. | |
| Field | Description |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| Object type: meta | |
|---|---|
| The metadata for an object, including the object type name and the URL reference to the object. | |
| Field | Description |
| @href | The URL reference to the object. |
| type | The name of the object type |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/user-session
{
"session-type":"Wildebeest",
"start":"2012-04-25T13:33:44.726Z",
"address":"Wildebeest",
"name":"Wildebeest",
"os-name":"Wildebeest"
}
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/Wildebeest
{
"meta":{
"type":"user-session",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/user-session/Wildebeest"
}
}