1. Home
  2. Kaseya BMS
  3. Step 1: Creating an API User in Kaseya BMS

Step 1: Creating an API User in Kaseya BMS

Introduction

Configuring the MSP Process platform to work with your Kaseya BMS server is a two-step process; first you need to create an API user in Kaseya BMS, and then you need to provide the API User's credentials to the MSP Process platform. This KB article will cover the first step; the second KB article is available here.

Creating a Custom Role for the API User

  1. Navigate to Admin -> Security -> Roles
  2. Click the New () button to create a new Security Role
    1. Name the role something that's easily understood, such as "MSP Process API User"
    2. Ensure that the Role Type is set to Internal, and the Status is set to Active
    3. Click the Save () button to save the Security Role
    4. In the Service Desk category, click the Allow View All and Allow Modify All buttons
    5. In the CRM category, enable the View permission for Accounts and both View and Modify for Contacts
    6. Click the Save () button to save your changes

 

Creating an API User in Kaseya BMS

Note: these instructions were sourced from this Kaseya BMS KB article.

  1. Login to your Kaseya BMS server
  2. Navgiate to Admin -> HR -> Employees
  3. Click the New () button to create a new user, and specify the following values:
    1. User Name: MSPProcessAPIUser
    2. First Name: MSP Process
    3. Emp ID: Whatever number makes sense for your organization
    4. Email Address: mspprocessAPIUser@.com (note that you'll need this to be a valid e-mail whose inbox you can access)
    5. Job Title: Administrator
    6. Department: Administration
    7. Manager: Pick an appropriate Manager within your organization
    8. Employment Type: Full Time
    9. Employee Roles: Administration
    10. Security Roles: Choose the Security Role that you created (i.e. MSP Process API User)
    11. Location: Pick an appropriate location
    12. User Type: Api Employee

  5. Click the Save ()button to save the new user
  6. Edit the user account, and click the Reset and Send Instructions button; when you receive that e-mail, change the password and save it, as we'll need the e-mail address of the user and the password in the second KB article.

Conclusion

Congratulations! You've now created a custom Security Role and an API user in Kaseya BMS, and you're ready to following the instructions in our second KB article, available here.