Search Device Management Policy

Searches for a device management policy with a policy name.

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

Query Parameters

  • namestring

    Search by name.

  • availableAppIdstring

    Search by app Name.

  • customizedboolean

    Search for cloned policies

  • parentPolicystring

    Search by parentPolicy UUID for cloned policies.

  • globalPolicyboolean

    Search on global policies.

  • nativeTypestring

    Search policies by nativeType cloned/global.

  • pageNointeger

    Integer Page number.

  • pageSizeinteger

    Integer Page Size.

  • orderBystring

    supported fields are name, createdDate, updatedDate, nativeType, availableAppId - String field.

  • isDescendingOrderboolean

    Boolean ascending/descending based on orderBy field.

Responses

  • matchTypestring

    (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.

    Enum:
    ALLANY
  • rulesarray

    (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

  • actionsarray

    - 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

  • idinteger

  • namestring

    Name of the policy.

  • resourceTypestring

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

  • executionOrderinteger

  • availableAppIdstring

    The unique identifier of the installed application/integration associated with the device management policy. This field is used to link the policy to a specific application integration (e.g., VMWARE, AWS, AZURE). When specified, the policy will only apply to resources discovered or managed through that particular application integration. Example values: - "VMWARE" for VMware integrations - "AWS" for AWS integrations - "AZURE" for Azure integrations

  • customizedboolean

    Indicates cloned/customised from Global Policy.

  • parentPolicystring

    The unique identifier (UUID) of the parent policy from which this policy was cloned. This field is only applicable for cloned/customized policies and helps track the lineage of policy inheritance.

  • globalPolicyboolean

    Indicates whether the policy is a global policy. Global policies are predefined system policies that can be used as templates across multiple tenants. When set to true, the policy is treated as a global policy; when false or omitted, it is a tenant-specific policy.

  • nativeTypestring

    Resource Native Type on which the policy is applicable. This is available for Global and Customized/Cloned policies.

  • pageNointeger

    The page number for paginated results. Use this parameter to navigate through multiple pages of policy results. Page numbering starts at 1.

  • pageSizeinteger

    The number of policy records to return per page. This parameter controls the size of each paginated result set. Maximum pageSize is 100.

  • orderBystring

    The field name by which to sort the policy results. Supported fields include: - "createdDate" - Sort by creation date - "updatedDate" - Sort by last update date - "nativeType" - Sort by nativeType of resource policy applies to - "availableAppId" - Sort By associated Integration/app - "name" - Sort by name of the policy

  • isDescendingOrderboolean

    Controls the sort order of the results based on the orderBy field. When set to true, results are sorted in descending order (Z-A, newest to oldest). When set to false or omitted, results are sorted in ascending order (A-Z, oldest to newest).

  • clientMatchingTypestring

    - The clientMatchingType field is optional and when not passed defaults to the following "clientMatchingType": "ALL" - The clientMatchingType field is applicable at partner-level DMP only. - If clientMatchingType EXCLUDE/INCLUDE, then the clients field is mandatory. - On policy update, if clientMatchingType is not passed then clientMatchingType will be updated to ALL and client selection will be removed.

    Enum:
    EXCLUDEINCLUDEALL

    Default: ALL

  • clientsarray

Loading Examples...