ACL Rule

An ACL Rule object defines access control for a specific API endpoint within a project. Rules specify which roles can access the endpoint, whether authentication is required, which fields are available in responses, and whether REST querying is enabled. ACL rules are grouped by endpoint path.

Sample Object

{
  "rest_query_enabled": true,
  "role": "ADMIN",
  "page_size": 50,
  "filterable_fields": ["email", "name", "status"],
  "available_fields": ["id", "email", "name", "created_at"],
  "token_required": true,
  "realm": "app"
}

Fields

Field	Type	Description
`rest_query_enabled`	`boolean`	Whether REST query filtering is enabled for this rule.
`role`	`string`	Role name this rule applies to.
`page_size`	`integer`	Maximum number of results per page for this rule.
`filterable_fields`	`array`	Fields that can be used as filters in REST queries.
`available_fields`	`array`	Fields that are visible in API responses for this rule.
`token_required`	`boolean`	Whether authentication is required for this rule.
`realm`	`string`	Realm scope for this rule.

Actions

Listing all ACL rules

Retrieve all ACL rules for the project.

obx app auth:acl list

| SUCCESS: ACL rules listed
| All ACL rules have been listed successfully.

GET /api/v1/platform/projects/:id/acl

Successful Response

{
  "endpoints": {
    "POST /api/v1/auth/accounts": {
      "rules": [
        {
          "rest_query_enabled": false,
          "role": "ADMIN",
          "token_required": true,
          "realm": "admin"
        }
      ]
    }
  }
}

Getting an ACL rule by key

Retrieve a single ACL rule or endpoint ruleset by its key.

obx app auth:acl get "POST /api/v1/auth/accounts"

| SUCCESS: ACL rule retrieved
| The ACL rule has been retrieved successfully.

GET /api/v1/platform/projects/:id/acl/:aclid

Successful Response

{
  "endpoint": "POST /api/v1/auth/accounts",
  "rules": [
    {
      "role": "ADMIN",
      "token_required": true,
      "realm": "admin"
    }
  ]
}

Pulling an ACL rule

Fetch an ACL rule by key and save it locally. This is the CLI-only workflow for editing rules offline.

obx app auth:acl pull "POST /api/v1/auth/accounts"

| SUCCESS: ACL rule pulled
| The ACL rule data has been saved.

Pushing an ACL rule

Create or update an ACL rule. The identifier is the endpoint key.

obx app auth:acl init

| SUCCESS: ACL rule initialized
| Edit the initialized ACL rule file.

After editing the template file:

obx app auth:acl push init

| SUCCESS: ACL rule pushed
| The ACL rule has been successfully pushed to the platform.

Auth Log