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

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/permission/{PermName}

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: permission
A Permission object contains the definition of a named privilege that can be assigned to a user account (via a UserGroup, or Role) in the Sentinel system.
FieldDescription
categoryThe category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc".
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
descA human-readable description of the permission's purpose.
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 internal name of the permission. This is typically not what is displayed in the Sentinel user interface.
typeThe type of permission. Currently only "boolean" is supported, which grants or denies the permission.
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/permission/shareFilters
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"permission",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/permission/shareFilters"
   },
   "category":"misc",
   "moddate":"2012-04-25T13:33:44.723Z",
   "desc":"Allow a user to selectively share event filters with users in the same role or everyone on the system.",
   "name":"shareFilters",
   "createdate":"2012-04-25T13:33:44.723Z",
   "type":"boolean"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: permission
A Permission object contains the definition of a named privilege that can be assigned to a user account (via a UserGroup, or Role) in the Sentinel system.
FieldRequiredDescription
categoryfalseThe category to which the permission belongs. Permission categories group permissions for internal management purposes. The value is one of "viewAll", "viewFiltered", "incidents", "misc".
descfalseA human-readable description of the permission's purpose.
nametrueThe internal name of the permission. This is typically not what is displayed in the Sentinel user interface.
typefalseThe type of permission. Currently only "boolean" is supported, which grants or denies the permission.

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/permission/shareFilters
{
   "category":"misc",
   "desc":"Allow a user to selectively share event filters with users in the same role or everyone on the system.",
   "name":"shareFilters",
   "type":"boolean"
}
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/permission/shareFilters