Identities - Identity Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/identity/{IdentityGuid}

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: identity
An Identity object contains information about a person in the enterprise that is monitored by the Sentinel system.
FieldDescription
accountsA URL that can be used to list Account objects that are associated with the identity data.
cidThe customer ID of the MSSP customer to which the identity belongs.
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
deptThe department to which the employee represented by the identity data belongs.
dnThe distinguished name, or "DN" of the identity record in the source system that supplied the identity data to Sentinel.
emailThe email address of the employee represented by the identity data.
givenThe given name of the employee represented by the identity data.
idoriginData identifying the source of the identity data in the originating system that supplied the identity data to Sentinel.
imgThe URL of a photograph depicting the employee represented by the identity data.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
mgrThe URL of the manager of the employee represented by the identity data.
moddateThe date and time when the object was last modified.
modifierThe URL of the Sentinel User object that represents the last modifier of the object.
nameA combination of given name and surname (and perhaps other names or initials) that identifies the employee represented by the identity data.
officeThe office location identifier of physical office belonging to the employee represented by the identity data.
phoneThe telephone number of the employee represented by the identity data.
srcidThe data that uniquely identifies the identity record in the source system that supplied the identity data to Sentinel.
surnameThe surname of the employee represented by the identity data.
titleThe job title or position of the employee represented by the identity data.
wfidThe workforce identifier of the employee represented by the identity data.
xattrsName-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.
FieldDescription
@hrefThe URL reference to the object.
typeThe 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.
FieldDescription
nameThe name of the value. For example, "Cell phone".
valueThe value.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757
Sample Response for application/json
Status: 200
{
   "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.651Z",
   "createdate":"2012-04-25T13:33:44.651Z",
   "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"
      }
   ]
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: identity
An Identity object contains information about a person in the enterprise that is monitored by the Sentinel system.
FieldRequiredDescription
accountsfalseA URL that can be used to list Account objects that are associated with the identity data.
cidfalseThe customer ID of the MSSP customer to which the identity belongs.
deptfalseThe department to which the employee represented by the identity data belongs.
dntrueThe distinguished name, or "DN" of the identity record in the source system that supplied the identity data to Sentinel.
emailfalseThe email address of the employee represented by the identity data.
givenfalseThe given name of the employee represented by the identity data.
idorigintrueData identifying the source of the identity data in the originating system that supplied the identity data to Sentinel.
imgfalseThe URL of a photograph depicting the employee represented by the identity data.
mgrfalseThe URL of the manager of the employee represented by the identity data.
namefalseA combination of given name and surname (and perhaps other names or initials) that identifies the employee represented by the identity data.
officefalseThe office location identifier of physical office belonging to the employee represented by the identity data.
phonefalseThe telephone number of the employee represented by the identity data.
srcidfalseThe data that uniquely identifies the identity record in the source system that supplied the identity data to Sentinel.
surnamefalseThe surname of the employee represented by the identity data.
titlefalseThe job title or position of the employee represented by the identity data.
wfidfalseThe workforce identifier of the employee represented by the identity data.
xattrsfalseName-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.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe 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.
FieldRequiredDescription
nametrueThe name of the value. For example, "Cell phone".
valuetrueThe value.

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/identity/79600390-9B73-102E-A3E2-001676E4A757
{
   "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"
      }
   ]
}
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/identity/79600390-9B73-102E-A3E2-001676E4A757