Inventory service data

Information about the User Roles managed by the console can be optionally included in the inventory data provided by the Inventory Service.

Inventory entries for User Role objects are included in the response to the Inventory Service's Get Inventory operation when the request specifies (explicitly by class, implicitly through a containing category, or by default) that objects of class "user-role" are to be included. An entry for a particular User Role is included only if the API user has access permission to that object as described in the Get User Role Properties operation.

For each User Role object to be included, the inventory response array includes an entry that is a JSON object with the same contents as is specified in the response body contents section for the Get User Role Properties operation. That is, the data provided is the same as would be provided if a Get User Role Properties operation were requested targeting this object.

Sample inventory data

The following fragment is an example of the JSON object that would be included in the Get Inventory response to describe a single User Role. This object would appear as one array entry in the response array:

Figure 1. User Role object: Sample inventory data
  {
      "associated-system-defined-user-role-uri": "/api/user-roles/b39afb87-d915-
         4070-a22f-91b158c6c01e", 
      "class": "user-role", 
      "description": "Role that allows management of users", 
      "is-inheritance-enabled": false, 
      "is-locked": false, 
      "name": "user_roles_9", 
      "object-id": "db7f9448-3737-11e4-a5fc-5ef3fcae8020", 
      "object-uri": "/api/user-roles/db7f9448-3737-11e4-a5fc-5ef3fcae8020", 
      "parent": "/api/console", 
      "permissions": [
         {
            "permitted-object": "/api/console/tasks/f8d653f4-eab2-4547-97c0- 
               a26f762218ba", 
            "permitted-object-type": "object"
         }, 
         {
            "permitted-object": "/api/console/tasks/36e32fb4-7b60-4677-b462-
               e786f337ea0f", 
            "permitted-object-type": "object"
         }, 
         {
            "permitted-object": "/api/console/tasks/8ef2b7ca-c2d2-4a5b-9d52-
               b4d1a28ccb15", 
            "permitted-object-type": "object"
         }
      ], 
      "replication-overwrite-possible": false, 
      "type": "user-defined"
   }