/portalAPI/PolicyMoveQueue/*

This article will cover all portalAPI calls that are related to /portalAPI/PolicyMoveQueue/* endpoints

 

If you are new to working with ThreatLocker PortalAPI endpoints and/or have questions regarding authentication and terminology used throughout this article, please look through the following guide:

Getting Started with ThreatLocker PortalAPIs

PolicyMoveQueueInsert

https://portalapi.INSTANCE.threatlocker.com/portalapi/PolicyMoveQueue/PolicyMoveQueueInsert

• Method: POST
• Description: This API is used when navigating to the Apps icon and selecting the Applications page from the pop-out menu in the ThreatLocker Portal, locating and selecting the application you wish to promote a policy on, navigating to the Existing Policies tab, selecting the Promote Policy button next to the policy you wish to promote, selecting where the policy should be promoted to, and selecting the green checkmark to confirm the promotion of the policy. This API promotes an Allowlisting policy in your organization. Ensure that the managedOrganizationId you use aligns with the organization where the policy exists. For more information on what to expect when promoting a policy, review the KB linked below:

Promoting Application Policies | ThreatLocker Help Center

Before attempting to promote a policy using this API, use the PolicyGetForPromotePolicyById API (documentation linked below) to review where the application's policy is currently applied, how many applications apply to it, and where it can be promoted to.

/portalAPI/Policy/* | ThreatLocker Help Center

• Required Body/Parameters
  • Fields
    • applicationId: This field determines the application(s) that will be promoted in association with the policy. When an Allowlisting policy with more than one application is promoted, ALL applications associated with the policy will be promoted with it. However, only one applicationId that applies to the policy is expected. When promoting from a child organization to a global group or to the global level using a child organization's application, the application will be moved to the parent organization to make it accessible to all relevant groups and organizations.
      • Expects a GUID in format: "00000000-0000-0000-0000-000000000000"
    • newPolicyComputerGroupId: This field determines where the policy will be promoted to. Note that Allowlisting policies already at a global group or global level cannot be promoted any higher. When promoting to a global group or to the global level for the selected application, ensure the GUID entered matches the global policy for the OS Type, and ensure that both the "Promote to Global" and "Promote to Group" permissions are assigned to your user. A child organization policy cannot be promoted to one of the parent's computer group levels or to the parent's entire organization level, except for the global group.
      • Expects a GUID in format: "00000000-0000-0000-0000-000000000000"
    • osType: This field determines the OS Type of the policy that will be promoted. Only Windows policies can be promoted to the entire organization level. When promoting to a global group or to the global level for the selected application, ensure the OS Type entered matches the global group's OS Type. This field expects the Integer associated with the OS Type:
      • Windows = 1
      • Mac = 2
      • Linux = 3
      • Windows XP = 5
    • parentId: This field is used when promoting a policy from a child organization to the parent organization at either a global group or global level. When promoting a policy to a level other than the global group or global level, this field can be omitted or set to "". This field expects the organizationId of the parent organization to which the policy is being promoted.
      • Expects a GUID in format: "00000000-0000-0000-0000-000000000000"
    • policyId: This field determines the policy that will be promoted. When the call to this API succeeds, a new policyId will be generated, and the old policy will be removed because a new policy has been promoted.
      • Expects a GUID in format: "00000000-0000-0000-0000-000000000000"

• Optional Body/Parameters
  • N/A
• Permission Requirements
  • Assign any one of the following permissions:
    • Promote to Entire Organization
    • Promote to Global
    • Promote to Group