| 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: identity | |
|---|---|
| An Identity object contains information about a person in the enterprise that is monitored by the Sentinel system. | |
| Field | Description |
| accounts | A URL that can be used to list Account objects that are associated with the identity data. |
| cid | The customer ID of the MSSP customer to which the identity 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. |
| dept | The department to which the employee represented by the identity data belongs. |
| dn | The distinguished name, or "DN" of the identity record in the source system that supplied the identity data to Sentinel. |
| The email address of the employee represented by the identity data. | |
| given | The given name of the employee represented by the identity data. |
| idorigin | Data identifying the source of the identity data in the originating system that supplied the identity data to Sentinel. |
| img | The URL of a photograph depicting the employee represented by the identity data. |
| meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
| mgr | The URL of the manager of the employee represented by the identity data. |
| 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 | A combination of given name and surname (and perhaps other names or initials) that identifies the employee represented by the identity data. |
| office | The office location identifier of physical office belonging to the employee represented by the identity data. |
| phone | The telephone number of the employee represented by the identity data. |
| srcid | The data that uniquely identifies the identity record in the source system that supplied the identity data to Sentinel. |
| surname | The surname of the employee represented by the identity data. |
| title | The job title or position of the employee represented by the identity data. |
| wfid | The workforce identifier of the employee represented by the identity data. |
| xattrs | Name-value pairs that contain additional items of interest about the identity data. For example, additional contact telephone numbers. 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 |
| Object type: idextattr | |
|---|---|
| A single IdentityExtAttributes object contains a name-value pair that is associated with an Identity object. The name-value pair definition is determined by the needs of the enterprise monitored by Sentinel. | |
| Field | Description |
| name | The name of the value. For example, "Cell phone". |
| value | The value. |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/identity?page=2&pagesize=1
{
"objects":[
{
"meta":{
"type":"identity",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757"
},
"office":"Wildebeest",
"phone":"Wildebeest",
"moddate":"2012-04-25T13:33:44.645Z",
"createdate":"2012-04-25T13:33:44.645Z",
"wfid":"Wildebeest",
"idorigin":"Wildebeest",
"surname":"Wildebeest",
"srcid":"Wildebeest",
"cid":42,
"title":"Wildebeest",
"given":"Wildebeest",
"email":"Wildebeest",
"name":"Wildebeest",
"dn":"Wildebeest",
"dept":"Wildebeest",
"accounts":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/account?query=uid.e79600390-9B73-102E-A3E2-001676E4A757"
},
"xattrs":[
{
"name":"Wildebeest",
"value":"Wildebeest"
}
]
}
],
"prev":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/identity?pagesize=1&page=1"
},
"next":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/identity?pagesize=1&page=3"
}
}
| Object type: identity | ||
|---|---|---|
| An Identity object contains information about a person in the enterprise that is monitored by the Sentinel system. | ||
| Field | Required | Description |
| accounts | false | A URL that can be used to list Account objects that are associated with the identity data. |
| cid | false | The customer ID of the MSSP customer to which the identity belongs. |
| dept | false | The department to which the employee represented by the identity data belongs. |
| dn | true | The distinguished name, or "DN" of the identity record in the source system that supplied the identity data to Sentinel. |
| false | The email address of the employee represented by the identity data. | |
| given | false | The given name of the employee represented by the identity data. |
| idorigin | true | Data identifying the source of the identity data in the originating system that supplied the identity data to Sentinel. |
| img | false | The URL of a photograph depicting the employee represented by the identity data. |
| mgr | false | The URL of the manager of the employee represented by the identity data. |
| name | false | A combination of given name and surname (and perhaps other names or initials) that identifies the employee represented by the identity data. |
| office | false | The office location identifier of physical office belonging to the employee represented by the identity data. |
| phone | false | The telephone number of the employee represented by the identity data. |
| srcid | false | The data that uniquely identifies the identity record in the source system that supplied the identity data to Sentinel. |
| surname | false | The surname of the employee represented by the identity data. |
| title | false | The job title or position of the employee represented by the identity data. |
| wfid | false | The workforce identifier of the employee represented by the identity data. |
| xattrs | false | Name-value pairs that contain additional items of interest about the identity data. For example, additional contact telephone numbers. Definition |
| 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: idextattr | ||
|---|---|---|
| A single IdentityExtAttributes object contains a name-value pair that is associated with an Identity object. The name-value pair definition is determined by the needs of the enterprise monitored by Sentinel. | ||
| Field | Required | Description |
| name | true | The name of the value. For example, "Cell phone". |
| value | true | The value. |
| Object type: | |
|---|---|
| The metadata representation of the newly-created identity 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 |
| Object type: idextattr | |
|---|---|
| A single IdentityExtAttributes object contains a name-value pair that is associated with an Identity object. The name-value pair definition is determined by the needs of the enterprise monitored by Sentinel. | |
| Field | Description |
| name | The name of the value. For example, "Cell phone". |
| value | The value. |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/identity
{
"office":"Wildebeest",
"phone":"Wildebeest",
"wfid":"Wildebeest",
"idorigin":"Wildebeest",
"surname":"Wildebeest",
"srcid":"Wildebeest",
"cid":42,
"title":"Wildebeest",
"given":"Wildebeest",
"email":"Wildebeest",
"name":"Wildebeest",
"dn":"Wildebeest",
"dept":"Wildebeest",
"accounts":{
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/account?query=uid.e79600390-9B73-102E-A3E2-001676E4A757"
},
"xattrs":[
{
"name":"Wildebeest",
"value":"Wildebeest"
}
]
}
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757
{
"meta":{
"type":"identity",
"@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757"
}
}