Endpoint
/api/v2/tenants/{tenantId}/policies/management

Gets device management policies of a tenant without pagination.

Path Parameters
tenantId
string

Describes the client ID of the tenant

Responses

OK

[
  {
    "actions": [],
    "executionOrder": 0,
    "id": 168,
    "matchType": "ANY",
    "name": "Test",
    "resourceType": "ALL",
    "rules": [
      {
        "filterType": "ANY_CLOUD_RESOURCE",
        "id": 155798
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": false,
        "items": [
          {
            "instances": {},
            "item": "4053",
            "parameters": {
              "Data Bytes": "64",
              "Packet Count": "3",
              "Packet interval": "1000"
            }
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 181,
    "matchType": "ALL",
    "name": "TestCAttrdf",
    "rules": [
      {
        "id": 156798,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "a"
      },
      {
        "id": 155833,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "b"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN KNOWLEDGEARTICLE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "7188"
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 208,
    "matchType": "ANY",
    "name": "TestCustom",
    "rules": [
      {
        "id": 155838,
        "isNativeAttribute": false,
        "key": "aws:cloudformation:stack-name",
        "operator": "Contains",
        "resourceType": "LOAD_BALANCER",
        "value": "catalogs"
      },
      {
        "id": 182199,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test2"
      },
      {
        "id": 174698,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test3"
      },
      {
        "id": 182239,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test4"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "Assign Availability Rule",
        "items": [
          {
            "item": "AND"
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 209,
    "matchType": "ANY",
    "name": "TestCustomDevice",
    "rules": [
      {
        "id": 155933,
        "isNativeAttribute": false,
        "key": "BusinessType",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "Internal"
      },
      {
        "id": 155843,
        "isNativeAttribute": false,
        "key": "aws:autoscaling:groupName",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "Test"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN CUSTOMATTRIBUTES",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "264313"
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 211,
    "matchType": "ALL",
    "name": "TestCombo",
    "rules": [
      {
        "id": 156833,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "active"
      },
      {
        "id": 178833,
        "isNativeAttribute": false,
        "key": "NewField",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "active"
      },
      {
        "id": 152833,
        "isNativeAttribute": true,
        "key": "Agent Installed",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "TRUE"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "instances": {},
            "item": "6693",
            "parameters": {}
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 240,
    "matchType": "ALL",
    "name": "TestLBPartner",
    "rules": [
      {
        "id": 182198,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "36218"
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 250,
    "matchType": "ALL",
    "name": "TestEpicGames",
    "rules": [
      {
        "id": 155333,
        "isNativeAttribute": false,
        "key": "TestEpic",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "TestEpicValue2"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "instances": {},
            "item": "6693",
            "parameters": {}
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 251,
    "matchType": "ALL",
    "name": "TestEpicElb",
    "rules": [
      {
        "id": 182198,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "instances": {},
            "item": "2761",
            "parameters": {
              "Apache Port": "8443"
            }
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 257,
    "matchType": "ALL",
    "name": "TestCase",
    "rules": [
      {
        "id": 115833,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "ce"
      },
      {
        "id": 155893,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "d"
      }
    ]
  },
  {
    "actions": [],
    "executionOrder": 0,
    "id": 264,
    "matchType": "ALL",
    "name": "TestPolicy2",
    "rules": [
      {
        "id": 255833,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "hydlpt311"
      },
      {
        "id": 156633,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "204"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "instances": {},
            "item": "2761",
            "parameters": {
              "Apache Port": "8443"
            }
          }
        ]
      },
      {
        "action": "UNASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "instances": {},
            "item": "971",
            "parameters": {}
          }
        ]
      },
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "instances": {},
            "item": "309",
            "parameters": {}
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 265,
    "matchType": "ALL",
    "name": "check-policy-name-update",
    "rules": [
      {
        "id": 155893,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test"
      }
    ]
  },
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": false,
        "items": [
          {
            "instances": {},
            "item": "4053",
            "parameters": {
              "Data Bytes": "64",
              "Packet Count": "3",
              "Packet interval": "1000"
            }
          }
        ]
      },
      {
        "action": "ASSIGN KNOWLEDGEARTICLE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "7188"
          }
        ]
      },
      {
        "action": "Assign Jobs",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "asset info",
            "itemType": "assetinfo",
            "itemUid": "c072cd67-779a-4206-a3d9-7c761fd563d8"
          }
        ]
      },
      {
        "action": "Assign Availability Rule",
        "items": [
          {
            "item": "AND"
          }
        ]
      },
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "36218"
          }
        ]
      },
      {
        "action": "ASSIGN CUSTOMATTRIBUTES",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "264313"
          }
        ]
      }
    ],
    "id": 85908,
    "matchType": "ALL",
    "name": "all actions",
    "rules": [
      {
        "id": 182208,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test"
      }
    ],
    "uid": "POLICY-4eb7d892-91dc-4ba9-bc92-980effbea64f"
  }
]
Endpoint
/api/v2/tenants/{tenantId}/policies/management

Creates a device management policy with required filters on the resources.

Path Parameters
tenantId
string

Describes the client ID of the tenant

actions
array

- Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response

actions.action
actions.forceAssignOrUnassign
actions.items
executionOrder
integer

id
integer

matchType
string

(Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY.

name
string

Name of the policy.

resourceType
string

Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER

rules
array

(Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource

rules.filterType
rules.id
rules.isNativeAttribute
rules.key
rules.operator
rules.resourceType
rules.value
[
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": false,
        "items": [
          {
            "instances": {},
            "item": "4053",
            "parameters": {
              "Data Bytes": "64",
              "Packet Count": "3",
              "Packet interval": "1000"
            }
          }
        ]
      },
      {
        "action": "ASSIGN KNOWLEDGEARTICLE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "7188"
          }
        ]
      },
      {
        "action": "Assign Jobs",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "asset info",
            "itemType": "assetinfo",
            "itemUid": "c072cd67-779a-4206-a3d9-7c761fd563d8"
          }
        ]
      },
      {
        "action": "Assign Availability Rule",
        "items": [
          {
            "item": "AND"
          }
        ]
      },
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "36218"
          }
        ]
      },
      {
        "action": "ASSIGN CUSTOMATTRIBUTES",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "tagName[value='tagValue']"
          }
        ]
      }
    ],
    "matchType": "ALL",
    "name": "all actions",
    "rules": [
      {
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test"
      }
    ]
  }
]
[
  {
    "actions": [
      {
        "action": "ASSIGN KNOWLEDGEARTICLE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "KB0000000123"
          }
        ]
      }
    ],
    "matchType": "ALL",
    "name": "TestArticle",
    "rules": [
      {
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "desktop"
      }
    ]
  }
]

Responses

OK

[
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": false,
        "items": [
          {
            "item": "4053"
          }
        ]
      },
      {
        "action": "ASSIGN KNOWLEDGEARTICLE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "7188"
          }
        ]
      },
      {
        "action": "Assign Jobs",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "asset info",
            "itemType": "assetinfo",
            "itemUid": "c072cd67-779a-4206-a3d9-7c761fd563d8"
          }
        ]
      },
      {
        "action": "Assign Availability Rule",
        "items": [
          {
            "item": "AND"
          }
        ]
      },
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "36218"
          }
        ]
      },
      {
        "action": "ASSIGN CUSTOMATTRIBUTES",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "264313"
          }
        ]
      }
    ],
    "createdDate": "2020-04-21T12:50:34+0000",
    "id": 85908,
    "matchType": "ALL",
    "name": "all actions",
    "rules": [
      {
        "id": 182208,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "test"
      }
    ],
    "uid": "POLICY-4eb7d892-91dc-4ba9-bc92-980effbea64f",
    "updatedDate": "2020-04-21T12:50:34+0000"
  }
]
[
  {
    "actions": [
      {
        "action": "ASSIGN KNOWLEDGEARTICLE",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "KB0000000123"
          }
        ]
      }
    ],
    "id": 9,
    "matchType": "ALL",
    "name": "TestArticle",
    "rules": [
      {
        "id": 16,
        "isNativeAttribute": true,
        "key": "Name",
        "operator": "Contains",
        "resourceType": "DEVICE",
        "value": "desktop"
      }
    ],
    "uid": "POLICY-ef02531c-b090-4535-8e83-968f00787fa6"
  }
]

Bad Request

[
  {
    "code": "0002",
    "fieldName": "item",
    "message": "ASSIGN CUSTOMATTRIBUTES action does not support Numerical item : 89, please use item : tagName[value='tagValue'] "
  }
]
Endpoint
/api/v2/tenants/{tenantId}/policies/management

Updates the device management policy.

Path Parameters
tenantId
string

Describes the client ID of the tenant

actions
array

- Supported actions - ASSIGN MONITORINGTEMPLATE - ASSIGN KNOWLEDGEARTICLE - Assign Availability Rule - ASSIGN CUSTOMATTRIBUTES - Assign Jobs - ASSIGN CREDENTIALSET - Supported values for items for given action - For Assign Availability Rule , item value is AND - For ASSIGN CUSTOMATTRIBUTES, item value is tagName[value='tagValue'] - For all others this is number in string eg "12345" - Scenarios for Custom attributes item values in response payload - New TagName : New Tag created with given Name and Tag Value, and Assigned. - Id of New Tag Value added to response - Old TagName and New Tag Value : New Tag Value added to Tag and Assigned - Id of New Tag Value added to response. - Old TagName and Old TagValue : Both the details are verfied and Assigned - Id of TagValue added to Response

actions.action
actions.forceAssignOrUnassign
actions.items
executionOrder
integer

id
integer

matchType
string

(Optional) The type of match: -To match all the filter conditions, provide matchType: ALL. - To match any one of the filter conditions, provide matchType: ANY.

name
string

Name of the policy.

resourceType
string

Type of resource. Example: DEVICE, VOLUME, VPN, XENSERVER

rules
array

(Optional) Filter devices with specific attributes: - Attribute name of device. Example: Name, Operating System. Attribute names change with device types. - Matching parameter. Supported operators are: Equals, Contains, Not Contains, Starts with, Ends with, Regex. Learn more about Regex. - Type of resource

rules.filterType
rules.id
rules.isNativeAttribute
rules.key
rules.operator
rules.resourceType
rules.value
[
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": false,
        "items": [
          {
            "instances": {},
            "item": "4053",
            "parameters": {
              "Data Bytes": "64",
              "Packet Count": "3",
              "Packet interval": "1000"
            }
          }
        ]
      },
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "36218"
          }
        ]
      }
    ],
    "id": 1790,
    "matchType": "ALL",
    "resourceType": "DEVICE",
    "rules": [
      {
        "key": "Name",
        "operator": "Contains",
        "value": "dc01-mysql-"
      }
    ]
  }
]

Responses

OK

[
  {
    "actions": [
      {
        "action": "ASSIGN MONITORINGTEMPLATE",
        "forceAssignOrUnassign": false,
        "items": [
          {
            "instances": {},
            "item": "4053",
            "parameters": {
              "Data Bytes": "64",
              "Packet Count": "3",
              "Packet interval": "1000"
            }
          }
        ]
      },
      {
        "action": "ASSIGN CREDENTIALSET",
        "forceAssignOrUnassign": true,
        "items": [
          {
            "item": "36218"
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 1790,
    "matchType": "ALL",
    "name": "Mysql-policy",
    "resourceType": "DEVICE",
    "rules": [
      {
        "key": "Name",
        "operator": "Contains",
        "value": "dc01-mysql-"
      }
    ]
  }
]

Bad Request

[
  {
    "code": "0002",
    "fieldName": "item",
    "message": "ASSIGN CUSTOMATTRIBUTES action does not support Numerical item : 89, please use item : tagName[value='tagValue'] "
  }
]