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: trust | |
---|---|
An Trust represents an item in an IT system that grants permissions to a user account in the IT system. | |
Field | Description |
accounts | A list of URLs of Sentinel Account objects that reference the Trust object. |
cid | The customer ID of the MSSP customer to which the external trust object 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 true, the Sentinel Trust object contains current data about the external trust object, as opposed to superceded data. |
desc | A prose description of the Trust object. |
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 name of the external trust object in the owning IT system. |
srcid | The uniquely identifying information of the external trust object in the originating system. |
sys | The identifier of the IT system from which the external trust information was obtained. |
type | The URL of the TrustType object that defines the type of trust information represented by the Sentinel Trust 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/trust?page=2&pagesize=1
{ "objects":[ { "meta":{ "type":"trust", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/trust/42" }, "moddate":"2012-04-25T13:33:44.656Z", "desc":"Wildebeest", "sys":"Wildebeest", "name":"Wildebeest", "createdate":"2012-04-25T13:33:44.656Z", "current":true, "srcid":"Wildebeest", "cid":42, "accounts":[ "https://164.99.19.131:8443/SentinelRESTServices/objects/account/42" ] } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/trust?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/trust?pagesize=1&page=3" } }
Object type: trust | ||
---|---|---|
An Trust represents an item in an IT system that grants permissions to a user account in the IT system. | ||
Field | Required | Description |
accounts | false | A list of URLs of Sentinel Account objects that reference the Trust object. |
cid | true | The customer ID of the MSSP customer to which the external trust object belongs. |
current | false | If true, the Sentinel Trust object contains current data about the external trust object, as opposed to superceded data. |
desc | false | A prose description of the Trust object. |
name | true | The name of the external trust object in the owning IT system. |
srcid | false | The uniquely identifying information of the external trust object in the originating system. |
sys | true | The identifier of the IT system from which the external trust information was obtained. |
type | false | The URL of the TrustType object that defines the type of trust information represented by the Sentinel Trust 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 trust 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/trust
{ "desc":"Wildebeest", "sys":"Wildebeest", "name":"Wildebeest", "current":true, "srcid":"Wildebeest", "cid":42, "accounts":[ "https://164.99.19.131:8443/SentinelRESTServices/objects/account/42" ] }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/trust/42
{ "meta":{ "type":"trust", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/trust/42" } }