REST API Group-based restrictions

Want to allow only specific groups to access API or generate tokens? You can do it using group-based restrictions.

Group-based restrictions provide a flexible and organized means of implementing access control, contributing to a more efficient and secure system. This provides the option for managing permissions based on groups rather than at the individual level.

miniOrange REST API Group Based Restriction

Allow API access

Enabling the “Allow API access” feature provides admins the privilege to select groups who can access API. Users outside the selected groups will be unable to access the APIs, ensuring that only selected groups can interact with API resources. This feature enhances the security by limiting the API exposure to defined user groups.

Code API Response
403 {
  "error": {
  "status": "ERROR",
  "message": "User is not allowed to authenticate"
  }
 }

Enable Read-only Groups

Enabling the “Enable Read-onlyGroups” feature allows admins to designate certain groups with read-only permissions for API interactions. By selecting specific groups, admins can ensure that users within these groups have access solely to read APIs, preventing them from performing any write operations

Code API Response
401 {
  "error": {
  "status": "ERROR",
  "message": "User does not have permission to execute this operation"
  }
 }

Allow Token Generation

Enabling the “Allow Token Generation” feature allows admins to designate specific groups with token generation privileges. This feature adds a layer of security and access control, restricting token generation to designated groups and preventing users outside of these groups from creating tokens.

Code API Response
403 {
  "error": {
  "status": "ERROR",
  "message": "User does not have permission to execute this operation"
  }
 }