/portalAPI/ComputerGroup/*

This article will encompass all portalAPI calls that are related to /portalAPI/ComputerGroup/* endpoints

 

Be sure to input the instance your organization exists on for each call. This is indicated with the "INSTANCE" text in each endpoint. Linked here is a KB to find your instance:

Locating Your Organization's Instance | ThreatLocker Help Center

ComputerGroupGetById

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetById

• Method: GET
• Description: This API is primarily used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal, then locating and selecting the group whose information you want to view. This API is also used whenever the computer group sidebar is accessed in the Portal. This API returns detailed group information for the selected group. To view information from a group in a different organization than the currently logged-in/managed organization, use the managedOrganizationId header as described below. Ensure the managedOrganizationId matches the location where the group exists.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
  • Parameters
    • computerGroupId: This field determines which group's information will be returned. To get a list of computerGroupIds, utilize the ComputerGroupGetByParameters API.
      • Expects: <GUID> in format "00000000-0000-0000-0000-000000000000"
• Optional Body/Parameters
  
  • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
• Permissions Needed for User
  • Edit Computer Groups
  • Install Computers
  • View Computer Groups

ComputerGroupGetByParameters

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetByParameters

• Method: POST
• Description: This API is used when navigating to the Assets icon and selecting the Groups page from the popout menu in the ThreatLocker Portal. This API is also used when selecting the Groups tab when in another portion of the Assets section of the Portal. This API returns all your device groups based on the fields you select. To view groups in a different organization than the currently logged in/managed organization, use the managedOrganizationId header as described below.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
  • Fields
    • pageNumber and pageSize: These fields determine how many groups will be returned, as if the response were on the Device Groups page. However, this field does not follow the same conventions for pageNumber and pageSize as the Portal does (the Portal uses 25, 50, or 100 for pageSize). Any valid integer can be entered, and it will return in the selected formatting. For instance, if there are 5 groups to be returned but “pageNumber”: 1 and “pageSize”: 2, 2 entries will be returned per page, and the first two groups will be shown.
      • Expects: An Integer value

• Optional Body/Parameters
  • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
  • Fields
    • osType: This field determines the OS type of the groups that will be returned.  When this field is omitted, all OS types will be returned based on the other fields used. This field expects the Integer associated with the OSType:
      • All = 0
      • Windows = 1
      • MAC = 2
      • Linux = 3
      • Windows XP = 5
      • Ingester = 6
      • iOS = 10
      • Android = 11
    • searchText: This field allows you to search/narrow the groups returned by inputting any text/details you want to search for. When this field is omitted, all groups will be displayed based on the other search fields. When text is entered into this field, it searches results by organization name and group name when showAllGroups is true or just by group name when showAllGroups is omitted or false, case-insensitively, effectively using wildcards on either side of the entered text. For example, when entering "Work" into this field, any group that contains the text "Work" anywhere in the name will be returned.
      • Expects: Any text input
    • showAllGroups: This field determines whether groups from your child organizations will be returned. When this field is omitted or set to false, only groups from the currently managed organization will be returned. When this field is set to true, all child organization groups, including grandchild organizations, will be returned.
      • Expects: true or false

• Permissions Needed for User
  • Edit Computer Groups
  • Install Computers
  • View Computer Groups

ComputerGroupGetDropdownWithOrganization

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetDropdownWithOrganization

• Method: GET
• Description: This API is used when copying policies from their respective pages, when looking to move computers on the Devices page, and when selecting to view computers from all child organizations on the Devices page in the ThreatLocker Portal. This API will return a list of all computer groups, including child organizations, and the organizations where they apply. This can be used to get all of the computer groups that can be installed into. The “label” field indicates the name of the organization or computer group. The “value” field is the organzationId or computerGroupId. When using the managedOrganizationId header, only the current organization and any child of the current organization will be displayed, unless the includeAvailableOrganizations field is used as described below.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
• Optional Body/Parameters
  • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
  • includeAvailableOrganizations: Will include a list of all the computer groups, including child AND parent organizations, and the organizations where they apply for any organization the effectively "logged in"/authenticated user has access to, regardless of the managedOrganizationId passed in.
• Permissions Needed for User
  • Edit Computers
  • Edit Computer Groups
  • View Computers

ComputerGroupGetDropdownByOrganizationId

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetDropdownByOrganizationId

• Method: GET
• Description: This API is used on the Devices page in the ThreatLocker Portal when viewing an invidual computer and is typically used to load the computer groups where the computer can be moved to within the organization. This API will return a list of computer groups from a specific organization. To narrow the search results down more to specific OS Types, it is important to use both the computerGroupOSTypeId field and the computerOSType fields. Ensure that the computerGroupOSTypeId and the computerOSType apply to the same operating system and do not conflict. (1 goes with "windows", 2 goes with "mac", etc.). If looking to view the computer groups from a different organization than the currently logged in/managed organization, utilize the managedOrganizationId header as described below.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
• Optional Body/Parameters
  • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000" 
  • computerGroupOSTypeId: This field expexts one of the Intergers from below to be entered AND should correspond with the computerOSType field from below:
    • Windows = 1
    • MAC = 2
    • Linux = 3
    • Windows XP = 5
  • computerOSType: This field expects one of the strings from below to be entered AND should correspond with the ID entered above:
    • "windows"
    • "mac"
    • "linux"
    • "windows xp"
• Permissions Needed for User
  • Edit Computers
  • View Computers
  • Install Computers

ComputerGroupGetForDownload

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetForDownload

• Method: GET
• Description: This API is used on the Devices page in the ThreatLocker Portal when selecting the Install Computer button and selecting a computer group to install into. This API will display the installation information for a computer group, including organizationId, name, OSType, whether the EULA has been accepted, whether a computer can be installed into the computer group, and whether there is a valid install link for the group. Utilize the install key for the computer group you would like to return the information from.
• Manadatory Body/Parameters
  • Valid APIKey/Authorization Token in header
  • installKey - 24 characters found on the Computer Groups page
• Optional Body/Parameters
  
  • N/A
• Permissions Needed for User
  • Since a valid install key is required to call this, no permissions are required

ComputerGroupGetForPermitApplication

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetForPermitApplication

• Method: GET
• Description: This API is used on the Response Center page in the ThreatLocker Portal when responding to an Application Control Approval Request and choosing a specific computer group to apply the request's Application Control policy to. This API populates the dropdown option when selecting Computer Group under the Applies To section of the Approval Request in the ThreatLocker Portal. To view the computer groups available from an Approval Request from a different organization than the currently logged in/managed organization, utlilize the managedOrganizationId header as described below.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
• Optional Body/Parameters
  
  • osType: This field determines the OS Type of the computer groups you are looking to view. OS Types to select from are listed below. This field expects the Integer associated with the OS Type to be entered:
    • Windows = 1
    • MAC = 2
    • Linux = 3
    • Windows XP = 5
  • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
• Permissions Needed for User

  • Approve for Entire Organization

  • Approve for Group

  • Approve for Single Computer

  • Approve for Single Computer Application Only

  • View Approvals

ComputerGroupGetGroupAndComputer

https://portalapi.INSTANCE.threatlocker.com/portalapi/ComputerGroup/ComputerGroupGetGroupAndComputer

• Method: GET
• Description: This API is used in most sidebars where policies are configured in the ThreatLocker Portal, including but not limited to, Application Control Policies, Storage Control Policies, and Network Control Policies. This API will retrieve a list of computers and groups depending on the parameters passed into the endpoint. If looking to view the computer groups from a different organization than the currently logged in/managed organization, utilize the managedOrganizationId header as described below.
• Required Body/Parameters
  • Valid APIKey/Authorization Token in header
• Optional Body/Parameters
  • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
  • OSType: This field will limit the computer groups displayed to those of the selected OS Type, OS Types to select from are listed below and this field expects the Integer associated with the OS Type:
    • All = 0
    • Windows = 1
    • MAC = 2
    • Linux = 3
    • Windows XP = 5
  • includeGlobal: This field will determine whether the Global group, used for permitting applications on a global scale across your organization(s), is displayed in the results.
    • Expects: true or false
  • includeOrganizations: This field can also include the organizations that the user/currently authorized user has access to. If managing a grandchild organization, only the grand-child organization will be displayed. If managing a child organization, the parent organization and any child organizations of that child will be displayed, a grand-child of the parent organization. 
    • Expects: true or false
  • includeParentGroups: This field will show all the parent computer groups, of the organization currently managed as long as the currently logged-in/authenticated user has access to the organization, including grandparents of the currently managed organization.
    • Expects: true or false
  • includeLoggedInObjects: This field will display additional information in the “label” fields of each computer group, computer, and organizations. For instance, if the organizations that are a direct parent of the currently managedOrganization will show “PARENT\\organizationName”, for the computer groups it will show “organizationName\\computerGroupName”, and for computers it will show “organizationName\\computerGroupName\\computerName”
    • Expects: true or false
• Permissions Needed for User
  • Super Admin