Identities - Account Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/account/{UserId}

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: 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.
FieldDescription
acctidThe unique identifier of the Account object in the Sentinel system.
cidThe customer ID of the MSSP customer to which the account belongs.
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
currentIf this value is true, it indicates that the account record contains the current data for an account, as opposed to containing superseded data.
enddateThe last, or ending data on which the account is active.
identityThe URL of the Identity object to which the Account object belongs.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
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.
nameThe account name in the IT system.
startdateThe first, or starting date on which the account is active.
statusThe current status of the account. One of "Active", "Inactive", "Deleted", "Undefined".
sysThe identifier of the system to which the account belongs.
trustsA list of URLs to Trust objects associated with the Account object.
uidThe 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.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/account/42
Sample Response for application/json
Status: 200
{
   "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.658Z",
   "startdate":"2012-04-25T13:33:44.658Z",
   "status":"Wildebeest",
   "sys":"Wildebeest",
   "name":"Wildebeest",
   "createdate":"2012-04-25T13:33:44.658Z",
   "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"
   ]
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

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.
FieldRequiredDescription
acctidfalseThe unique identifier of the Account object in the Sentinel system.
cidfalseThe customer ID of the MSSP customer to which the account belongs.
currentfalseIf this value is true, it indicates that the account record contains the current data for an account, as opposed to containing superseded data.
enddatefalseThe last, or ending data on which the account is active.
identityfalseThe URL of the Identity object to which the Account object belongs.
nametrueThe account name in the IT system.
startdatefalseThe first, or starting date on which the account is active.
statusfalseThe current status of the account. One of "Active", "Inactive", "Deleted", "Undefined".
systrueThe identifier of the system to which the account belongs.
trustsfalseA list of URLs to Trust objects associated with the Account object.
uidfalseThe 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.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/account/42
{
   "uid":"79600390-9B73-102E-A3E2-001676E4A757",
   "acctid":"79600390-9B73-102E-A3E2-001676E4A757",
   "startdate":"2012-04-25T13:33:44.659Z",
   "status":"Wildebeest",
   "sys":"Wildebeest",
   "name":"Wildebeest",
   "current":true,
   "enddate":"2012-04-25T13:33:44.659Z",
   "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"
   ]
}
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/account/42