/portalAPI/User/*

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

UserGetAllTimezones

https://portalapi.INSTANCE.threatlocker.com/portalapi/User/UserGetAllTimezones

• Method: GET
• Description: This API is used to get the timezone information needed throughout the ThreatLocker Portal. This API is helpful for retrieving all ID values when specifying a time zone through various APIs. For instance, when creating a new organization, a time zone must be specified. This API can be called to retrieve all the time zones available for use with the new organization.
• Required Body/Parameters
  
  • N/A
• Optional Body/Parameters
  • N/A 
• Permissions Needed for User
  
  • Since the information returned from this API is public information, no specific ThreatLocker-related permissions are required; Just a valid APIKey/Authorization Token

UserInviteByUsername

https://portalapi.INSTANCE.threatlocker.com/portalapi/User/UserInviteByUsername

• Method: POST
• Description: This API is used when navigating to the Users page in the ThreatLocker Portal, selecting the "Invite User" button in the top left corner, selecting a role(s) that will apply to the newly invited user, and selecting the "Send" button. This API is directly responsible for creating and sending the invite to the username (email) entered. If creating a new invitation for a user in a different organization than the currently logged-in/managed organization, utilize the managedOrganizationId header. When inviting a new user to the ThreatLocker Portal, only the currently managed organization with the roles that have been created in that specific organization can be used with this API.
• Required Body/Parameters
  • Fields

• • • roles: This field specifies the role(s) that will be attached to the newly invited user. Listed below are the fields required for each role:

Note: To get the Roles that can be specified for the organization, use the UserRolesGetByParameters API to get the roles that can be applied. Be sure to use the same managedOrganizationId as where the user is being invited and where you are searching for the roles to ensure that the roles searched and applied are in the same organization as where the new user will be invited.

• • • • organizationId: This field expects the ID of the organization where the new user will be invited into. Utilizing this field limits the scope of the role to just the organization where the new user is being invited to manage.
        • Expects a GUID in format: "00000000-0000-0000-0000-000000000000"
      • userRoleId: This field expects the ID of the role that will be applied to the newly invited user.
        • Expects a GUID in format: "00000000-0000-0000-0000-000000000000"

• • • username: This field specifies the username/email address that will be sent the invite. When this call is completed, the email/user account will appear in the Portal with no account details or name; only the email address will be displayed. The additional details will be completed once the user receives the email and logs into the Portal for the first time.
      • Expects: Any valid email address

• Optional Body/Parameters
  • N/A
• Permissions Needed for User
  • Edit Administrators
  • Assign Roles