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: account | |
---|---|
An Account contains information about a user account in an IT system in enterprise monitored by Sentinel. Multiple Accounts may be associated with a single Identity. | |
Field | Description |
acctid | The unique identifier of the Account object in the Sentinel system. |
cid | The customer ID of the MSSP customer to which the account belongs. |
createdate | The date and time when the object was created. |
creator | The URL of the Sentinel User object that represents the creator of the object. |
current | If this value is true, it indicates that the account record contains the current data for an account, as opposed to containing superseded data. |
enddate | The last, or ending data on which the account is active. |
identity | The URL of the Identity object to which the Account object belongs. |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
moddate | The date and time when the object was last modified. |
modifier | The URL of the Sentinel User object that represents the last modifier of the object. |
name | The account name in the IT system. |
startdate | The first, or starting date on which the account is active. |
status | The current status of the account. One of "Active", "Inactive", "Deleted", "Undefined". |
sys | The identifier of the system to which the account belongs. |
trusts | A list of URLs to Trust objects associated with the Account object. |
uid | The unique identifier in the Sentinel system of the Identity object to which the Account object belongs. |
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/account?page=2&pagesize=1
{ "objects":[ { "meta":{ "type":"account", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/account/42" }, "uid":"79600390-9B73-102E-A3E2-001676E4A757", "acctid":"79600390-9B73-102E-A3E2-001676E4A757", "moddate":"2012-04-25T13:33:44.657Z", "startdate":"2012-04-25T13:33:44.657Z", "status":"Wildebeest", "sys":"Wildebeest", "name":"Wildebeest", "createdate":"2012-04-25T13:33:44.657Z", "current":true, "enddate":"2012-04-25T13:33:44.657Z", "cid":42, "identity":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757" }, "trusts":[ "https://164.99.19.131:8443/SentinelRESTServices/objects/trust/42" ] } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/account?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/account?pagesize=1&page=3" } }
Object type: account | ||
---|---|---|
An Account contains information about a user account in an IT system in enterprise monitored by Sentinel. Multiple Accounts may be associated with a single Identity. | ||
Field | Required | Description |
acctid | false | The unique identifier of the Account object in the Sentinel system. |
cid | false | The customer ID of the MSSP customer to which the account belongs. |
current | false | If this value is true, it indicates that the account record contains the current data for an account, as opposed to containing superseded data. |
enddate | false | The last, or ending data on which the account is active. |
identity | false | The URL of the Identity object to which the Account object belongs. |
name | true | The account name in the IT system. |
startdate | false | The first, or starting date on which the account is active. |
status | false | The current status of the account. One of "Active", "Inactive", "Deleted", "Undefined". |
sys | true | The identifier of the system to which the account belongs. |
trusts | false | A list of URLs to Trust objects associated with the Account object. |
uid | false | The unique identifier in the Sentinel system of the Identity object to which the Account object belongs. |
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 account 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/account
{ "uid":"79600390-9B73-102E-A3E2-001676E4A757", "acctid":"79600390-9B73-102E-A3E2-001676E4A757", "startdate":"2012-04-25T13:33:44.658Z", "status":"Wildebeest", "sys":"Wildebeest", "name":"Wildebeest", "current":true, "enddate":"2012-04-25T13:33:44.658Z", "cid":42, "identity":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757" }, "trusts":[ "https://164.99.19.131:8443/SentinelRESTServices/objects/trust/42" ] }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/account/42
{ "meta":{ "type":"account", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/account/42" } }