Entity - Role Based Access Control - Interrogates the SecurableType table in the database

Page version: 17, last updated:



VerbRequestNotesPermissions required
GET - all/Consumer/SecurableTypes

Gets list of all available Securable Types

Example Response
[
    {
        "Id": 1,
        "Name": "ProductPack",
		"CreatedTimestampUtc": "2016-02-03T17:20:06.927",
        "ModifiedTimestampUtc": "2016-02-03T17:20:06.927",
        "ApplicableOperations": [],
        "Operations": [
             {
                 "Id":1,
                 "OperationName":"Viewer",
                 "SecurableTypeId":1,
                 "SecurableTypeName":"ProductPack"
             },
             {
                 "Id":2,
                 "OperationName":"Actioner",
                 "SecurableTypeId":1,
                 "SecurableTypeName":"ProductPack"
             }
         ]
    },
    {
        "Id": 2,
        "Name": "Security",
        "CreatedTimestampUtc": "2016-02-03T17:20:06.927",
        "ModifiedTimestampUtc": "2016-02-03T17:20:06.927",
        "ApplicableOperations": [],
        "Operations": [
             {
                 "Id": 5,
                 "OperationName": "Read",
                 "SecurableTypeId": 2,
                 "SecurableTypeName": "Security"
             }
         ]
    },
]
  • Read

Returns Unauthorized (401) if user does not have the required permissions.

GET - single/Consumer/SecurableTypes/{securableId}

Gets details for the specified Securable ID

Example Request
{
    "Id": 1,
    "Name": "ProductPack",
    "CreatedTimestampUtc": "2016-02-03T17:20:06.927",
    "ModifiedTimestampUtc": "2016-02-03T17:20:06.927",
    "ApplicableOperations": [],
    "Operations": [
         {
             "Id":2,
             "OperationName":"Actioner",
             "SecurableTypeId":1,
             "SecurableTypeName":"ProductPack"
         },
         {
             "Id":1,
             "OperationName":"Viewer",
             "SecurableTypeId":1,
             "SecurableTypeName":"ProductPack"
         }
     ]
}
  • Read

Returns Unauthorized (401) if user does not have the required permissions.

GET/Consumer/SecurableTypes/Name/{name}As above but by name
  • Read

Returns Unauthorized (401) if user does not have the required permissions.

POST/Consumer/SecurableTypes

Creates a securable type record.

Example Request
{
    "Name": "SecurableType"
}
  • Write

Returns Unauthorized (401) if user does not have the required permissions.

PUT/Consumer/SecurableTypes

Modifies an existing securable type entry. Only name can be modified.

Example Request
{
    "Id": 10,
    "Name": "Modified Securable Type"
}
  • Write

Returns Unauthorized (401) if user does not have the required permissions.

DELETE/Consumer/SecurableTypes/{securableId}

Deletes the specified securable type if it exists, otherwise "ExceptionMessage": "SecurableType record with Id={id} was not found".

  • Write

Returns Unauthorized (401) if user does not have the required permissions.