API Reference - Admin Role Plugin Permissions

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108130

← Back to API Reference | Getting Started

Admin Role Plugin Permissions

Admin Role Plugin Permissions control which admin panel plugins (addon sections) are visible to each admin role. Each record links a role to a specific plugin and defines whether members of that role can access it. This is separate from the core permission system and applies specifically to plugin-based admin sections.

Model name in URL: admin_role_plugins_permissions — DB table: admin_role_plugins_permissions

The Admin Role Plugin Permission Object

FieldTypeDescription
role_plugins_permissions_idintegerUnique plugin permission assignment ID (primary key, read-only)
role_idintegerForeign key referencing the admin_roles table required on create
plugin_idintegerForeign key referencing the plugin_records table required on create
can_viewintegerWhether this role can access the plugin; 1 = accessible, 0 = hidden required on create
assigned_byintegerForeign key referencing the administrator who assigned this plugin permission required on create

List Admin Role Plugin Permissions

GET /api/v2/admin_role_plugins_permissions/get

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/admin_role_plugins_permissions/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "role_plugins_permissions_id": "1",
      "role_id": "4",
      "plugin_id": "3",
      "can_view": "1",
      "assigned_by": "27"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Retrieve an Admin Role Plugin Permission

GET /api/v2/admin_role_plugins_permissions/get/{role_plugins_permissions_id}

Example Request

Copy
curl -X GET "https://www.yourdomain.com/api/v2/admin_role_plugins_permissions/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy
{
  "status": "success",
  "message": [
    {
      "role_plugins_permissions_id": "1",
      "role_id": "4",
      "plugin_id": "3",
      "can_view": "1",
      "assigned_by": "27"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create an Admin Role Plugin Permission

POST /api/v2/admin_role_plugins_permissions/create

Example Request

Copy
curl -X POST "https://www.yourdomain.com/api/v2/admin_role_plugins_permissions/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "role_id=4" \
  -d "plugin_id=3" \
  -d "can_view=1" \
  -d "assigned_by=27"

Example Response

Copy
{
  "status": "success",
  "message": {
    "role_plugins_permissions_id": "2",
    "role_id": "4",
    "plugin_id": "3",
    "can_view": "1",
    "assigned_by": "27"
  }
}

Update an Admin Role Plugin Permission

PUT /api/v2/admin_role_plugins_permissions/update

Example Request

Copy
curl -X PUT "https://www.yourdomain.com/api/v2/admin_role_plugins_permissions/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "role_plugins_permissions_id=2" \
  -d "can_view=0"

Example Response

Copy
{
  "status": "success",
  "message": {
    "role_plugins_permissions_id": "2",
    "role_id": "4",
    "plugin_id": "3",
    "can_view": "0",
    "assigned_by": "27"
  }
}

Delete an Admin Role Plugin Permission

DELETE /api/v2/admin_role_plugins_permissions/delete

Example Request

Copy
curl -X DELETE "https://www.yourdomain.com/api/v2/admin_role_plugins_permissions/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "role_plugins_permissions_id=2"

Example Response

Copy
{
  "status": "success",
  "message": "admin_role_plugins_permissions record was deleted"
}