User Roles Authorization is a critical feature, where endpoints access is governed by API key authorizations. These authorizations are linked to roles assigned to the user who owns a specific API key.

In the 'User Roles' section, the API categorizes users into four primary roles:

  1. Administrator: Has the highest level of access, capable of managing all aspects of the system.

  2. LicenseManager: Focuses on licensing aspects, with permissions to manage and oversee licensing operations.

  3. Sales: Handles sales-related functionalities and accesses customer and sales data.

  4. Customer: Primarily interacts with customer-facing features and has limited access compared to other roles.

This role-based access control ensures that users can only interact with parts of the API that are relevant to their roles, enhancing security and operational efficiency. For instance, an API key assigned to a 'Sales' user will have different access permissions compared to one assigned to an 'Administrator'.

Where not explicitly stated, only users in the 'Administrator' role are granted access to the endpoints. To provide clear guidance, the roles permitted to access a specific endpoint will be distinctly outlined at the beginning of each endpoint definition. This ensures transparency in access control and allows users to quickly identify which endpoints are accessible based on their assigned roles.

Example of Roles Allowed to Access an Endpoint

Roles: Administrator, LicenseManager, Sales




Last updated