Users and Roles - UserGroup Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/role/{GroupId}

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: role
A UserGroup, or Role, defines permissions and other information that user accounts may have. User accounts gain permissions by virtue of role membership.
FieldDescription
all-eventsIf true, users belong to this role may view all events unfiltered, including system events. If false, the filter value is applied limiting the events role members may view.
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
descA short description of the Role to help users understand the Role's purpose.
filterThe filter that is applied to event searches performed by users belonging to this role. The event filter is only applied if all-events is false.
isadminIf true, indicates that members of this role have administrator privileges.
membersA list of references to user objects that are members of this role.
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 name by which the Role is referred to in the user interface and APIs.
permsThe collection of permission definitions assigned to this role. Definition
readonlyIf true, indicates that this role may not be modified.
search-initiatorsA list of references to any search initiator objects that are associated with this role for the purposes of Distributed Search.
tagsA list of tag names that are associated with this role.
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: group-perm
A UserGroupPermission object associates a Permission with a UserGroup and defines whether the UserGroup grants or denies the privilege associated with the Permission.
FieldDescription
defThe URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object.
nameThe name of the Permission object associated with the UserGroup object.
valueThe value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/role/79600390-9B73-102E-A3E2-001676E4A757
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"role",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/role/79600390-9B73-102E-A3E2-001676E4A757"
   },
   "moddate":"2012-04-25T13:33:44.717Z",
   "desc":"This role is intended to be used for our company's internal network administrators that need access to collected Sentinel events relating to the internal network.",
   "all-events":false,
   "name":"Internal Network Administrator",
   "createdate":"2012-04-25T13:33:44.717Z",
   "readonly":false,
   "isadmin":false,
   "filter":"rv145:\"Network\"",
   "tags":[
      "PCI"
   ],
   "perms":[
      {
         "name":"shareFilters",
         "value":"true",
         "def":{
            "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/permission/shareFilters"
         }
      }
   ],
   "members":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/user/42"
   ],
   "search-initiators":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/search-initiator/79600390-9B73-102E-A3E2-001676E4A757"
   ]
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: role
A UserGroup, or Role, defines permissions and other information that user accounts may have. User accounts gain permissions by virtue of role membership.
FieldRequiredDescription
all-eventsfalseIf true, users belong to this role may view all events unfiltered, including system events. If false, the filter value is applied limiting the events role members may view.
descfalseA short description of the Role to help users understand the Role's purpose.
filterfalseThe filter that is applied to event searches performed by users belonging to this role. The event filter is only applied if all-events is false.
membersfalseA list of references to user objects that are members of this role.
nametrueThe name by which the Role is referred to in the user interface and APIs.
permsfalseThe collection of permission definitions assigned to this role. Definition
tagsfalseA list of tag names that are associated with this role.

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: group-perm
A UserGroupPermission object associates a Permission with a UserGroup and defines whether the UserGroup grants or denies the privilege associated with the Permission.
FieldRequiredDescription
deffalseThe URL of the Permission object that is associated with the UserGroup by the UserGroupPermission object.
nametrueThe name of the Permission object associated with the UserGroup object.
valuefalseThe value assigned to the UserGroup-Permission relationship. Currently only "true" and "false" are supported, and imply "GRANT" and "DENY", respectively.

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/role/79600390-9B73-102E-A3E2-001676E4A757
{
   "desc":"This role is intended to be used for our company's internal network administrators that need access to collected Sentinel events relating to the internal network.",
   "all-events":false,
   "name":"Internal Network Administrator",
   "filter":"rv145:\"Network\"",
   "tags":[
      "PCI"
   ],
   "perms":[
      {
         "name":"shareFilters",
         "value":"true",
         "def":{
            "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/permission/shareFilters"
         }
      }
   ],
   "members":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/user/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/role/79600390-9B73-102E-A3E2-001676E4A757