Configure permissions for specific API Endpoints

In addition to the permissions which control access to the API, there are some endpoints within the API that require access to MSP Manager features which are governed by permissions. These permissions need to be granted to users in order for them to be able to interact with those endpoints in the API.

For instance, in order to use PUT or POST operations for Customer endpoints, the Create Customer permission must be enabled in your MSP Manager settings. Additionally, accessing any Bills or Assets endpoints requires the View Billing or View Assets permissions.

All required permissions for interacting with API endpoints are listed below:

Asset Endpoint permissions

Ensure the View Assets permission is granted to users to access Asset endpoints in the API and enable the Manage Asset permission to use PUT and POST operations in the API.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Select to edit the roles that require permissions for custom asset fields.
  3. Select the Asset Management section to expand it's options.
  4. Select the View Assets and Manage Asset permissions to apply to the role or select All Asset Management to apply all permissions.
  5. Click Save when finished.

Billing Endpoint permissions

Ensure the View Billing permission is granted to users to access Bills endpoints in the API.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Click the Edit icon next to the role that requires Billing permissions.
  3. Select the Billing And Finance section to expand its options.
  4. Select the View Billing permission to ensure users can interact with the Bills Endpoints in the API.
  5. Click Save when finished.

Contact Endpoint permissions

In order to use PUT and POST operations to create or edit contacts, ensure the Create Contact and Edit Contact permissions are enabled.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Click the Edit icon next to the role that requires Customer Management permissions.
  3. Select the Customer Management section to expand its options.
  4. Select the Create Contact and Edit Contact permissions or click All Customer Management to select all available permissions.
  5. Click Save when finished.

Customer Endpoint permissions

In order to use PUT and POST operations to update or create customers, ensure the Create Customers and Edit Customers Information permissions are enabled.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Click the Edit icon next to the role that requires Customer Management permissions.
  3. Select the Customer Management section to expand its options.
  4. Select the Create Customers and Edit Customers Information permissions users in the selected Role require or click All Customer Management to select all available permissions.
  5. Click Save when finished.

Location Endpoint permissions

Enable the Create Location and Edit Location permissions to use PUT and POST operations to create and update location info for customers.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Click the Edit icon next to the role that requires Location permissions.
  3. Select the Customer Management section to expand its options.
  4. Enable the Create Location and Edit Location permissions or click All Customer Management to select all available permissions.
  5. Click Save when finished.

Service Item Endpoint permissions

In order to use PUT and POST operations to update or create Service Items, ensure the Configure Service Items permission is enabled.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Click the Edit icon next to the role that requires Billing permissions.
  3. Select the Billing And Finance section to expand its options.
  4. Select the Configure Service Items permission.
  5. Click Save when finished.

In addition to the required permissions, it is important to note that service item start and end dates are stored in local time, not UTC.

Ticketing Endpoint permissions

In order to use PUT and POST operations to create, update and add time entries to tickets, ensure the Create Ticket, Update Ticket and associated items and Add Time to Tickets permissions are enabled.

  1. Navigate to Settings > Users & Permissions > Roles.
  2. Click the Edit icon next to the role that requires Ticketing permissions.
  3. Select the Helpdesk section to expand its options.
  4. Select Create Ticket, Update Ticket and associated items and Add Time to Tickets to grant those permissions to users in the selected Role.
  5. Click Save when finished.