Company logoHelp Center
Visit www.threatlocker.com

/portalAPI/Organization/*

3 min. readlast update: 10.31.2024

This article will encompass all portalAPI calls that are related to /portalAPI/Organization/* 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

 

OrganizationGetAuthKeyById

https://portalapi.INSTANCE.threatlocker.com/portalapi/Organization/OrganizationGetAuthKeyById

  • Method: GET
  • Description: This API will return the Authorization Key of the currently managed organization, typically the parent organization or where the currently authenticated user is "logged in"/exists at. This AuthKey is used in association with the Logon Scripts that check whether ThreatLocker is installed onto your endpoints already. The AuthKey is used in the script itself so that if ThreatLocker is not installed, it will send the computer information into the ThreatLocker portal under the "Not Installed" tab. To get the Auth Key for a child organization, include an additional header for “managedOrganizationId” and input the organizationId where you would like to get the AuthKey.
  • Required body/parameters
    • Requires valid APIKey/Authorization Token in header
  • Optional body/parameters
    • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
  • Permissions
    • Edit Computers
    • Install Computers

 

OrganizationUpdateAuthKeyById

https://portalapi.INSTANCE.threatlocker.com/portalapi/Organization/OrganizationUpdateAuthKeyById

  • Method: POST
  • Description: This API will generate the Authorization Key for an Organization. To generate an Auth Key for a child organization, include an additional header for “managedOrganizationId” and input the organizationId where you would like to generate the AuthKey. If there is already an Auth Key generated for the organization, the following message will be displayed: "The organization already has AuthKey, can't be updated." This AuthKey is static once initially created and is used in association with the Logon Scripts that check whether ThreatLocker is installed onto your endpoints already. The AuthKey is used in the script itself so that if ThreatLocker is not installed, it will send the computer information into the ThreatLocker portal under the "Not Installed" tab.
  • Required body/parameters
    • Requires valid APIKey/Authorization Token in header
  • Optional body/parameters
    • In header: "managedOrganizationId": <GUID> in format "00000000-0000-0000-0000-000000000000"
  • Permissions
    • Edit Computers
    • Install Computers

 

OrganizationGetForMoveComputers

https://portalapi.INSTANCE.threatlocker.com/portalapi/Organization/OrganizationGetForMoveComputers

  • Method: GET
  • Description: This API will return a list of Organizations that can be the target to move computers to. A list of organizations the currently logged in/authenticated user has access to will be displayed. The “label” field is the organization name and the “value” field is the orgazanizationId.
  • Required body/parameters
    • Requires valid APIKey/Authorization Token in header
  • Optional body/parameters
    • searchText: Allows you to effectively search through the list of your organizations by inputting the name of the organization
  • Permissions
    • Edit Computers
Was this article helpful?