Skip to main content
POST
/
check_brx_acl
Check BRK ACL
curl --request POST \
  --url https://api.example.com/check_brx_acl \
  --header 'Content-Type: application/json' \
  --data '
{
  "brxId": "<string>"
}
'
{
  "400": {},
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": true,
      "isClone": true,
      "brxId": "<string>",
      "emails": [
        {
          "email": "<string>",
          "permission": 123
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.brx.ai/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves the access control list (ACL) for a BRK. It allows you to check the visibility of a BRK (public or private), whether it can be cloned, and the list of users who have access to it along with their permission levels. You must have at least viewer permissions for the BRK to access its ACL.

​
Request

​
brxId
string
required
The ID of the BRK to check ACL for

​
Example Request

{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}

​
Response

​
getBrxACLResponse
object

​
Example Response (Private BRK)

{
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": false,
      "isClone": true,
      "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef",
      "emails": [
        {
          "email": "owner@example.com",
          "permission": 2
        },
        {
          "email": "editor@example.com",
          "permission": 1
        },
        {
          "email": "viewer@example.com",
          "permission": 0
        }
      ]
    }
  }
}

​
Example Response (Public BRK)

{
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": true,
      "isClone": true,
      "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef",
      "emails": [
        {
          "email": "owner@example.com",
          "permission": 2
        }
      ]
    }
  }
}

​
Error Codes

​
400
object
Bad Request - The request was malformed or missing required parameters
​
401
object
Unauthorized - Authentication credentials are missing or invalid
​
403
object
Forbidden - The authenticated user does not have permission to check the ACL for the requested BRK
​
404
object
Not Found - The requested BRK does not exist
​
500
object
Internal Server Error - An unexpected error occurred on the server

​
Notes

  • You must have at least viewer permissions for the BRK to access its ACL.
  • The response includes the visibility of the BRK (isPublic), whether it can be cloned (isClone), and the list of users who have access to it along with their permission levels.
  • Permission levels:
    • 0: Viewer (can view and execute the BRK)
    • 1: Editor (can view, execute, and edit the BRK)
    • 2: Owner (can view, execute, edit, and delete the BRK, as well as manage permissions)
  • To update the ACL for a BRK, use the Update BRK ACL endpoint.