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.
Permission level for the user. 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)
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.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"DOCS","colors":{"primary":"#36332e","light":"#f3e6cd","dark":"#36332e"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/brx/zBGB5rG4WcaJLc2G/logo/brx_logo_dark_big.svg?fit=max\u0026auto=format\u0026n=zBGB5rG4WcaJLc2G\u0026q=85\u0026s=192d2c11b5bf54ed66b86c20da9ce796","dark":"https://mintcdn.com/brx/zBGB5rG4WcaJLc2G/logo/brx_logo_light_big.svg?fit=max\u0026auto=format\u0026n=zBGB5rG4WcaJLc2G\u0026q=85\u0026s=6461c1ae8dfa7b34cfbb218805fd59c6"},"navbar":{"links":[],"primary":{"type":"button","label":"App","href":"https://app.brx.ai"}},"footer":{"socials":{"website":"https://brx.ai","x":"https://x.com/jandodev","github":"https://github.com/brx-ai","linkedin":"https://www.linkedin.com/company/brxai/"}},"navigation":{"global":{"anchors":[{"anchor":"Documentation","href":"https://predocs.brx.ai","icon":"book-open-cover"},{"anchor":"Community","href":"https://join.slack.com/t/brx-communityslack/shared_invite/zt-2vfndoyuv-FTxv0Wc2CzpfO6TH3VHpkg","icon":"slack"},{"anchor":"Github","href":"https://github.com/brx-ai","icon":"github"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brx","hasAudioNarration":false,"actualSubdomain":"brx","customDomains":["docs.brx.ai"],"gitSource":{"type":"github","owner":"brx-ai","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"edits":true,"issues":true},"entitlements":{},"buildId":"6ae92347abb6d0c12b814cd5:success","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"API Reference","count":11},{"language":"default","tag":"Core Concepts","count":8},{"language":"default","tag":"BRK Management","count":3},{"language":"default","tag":"API Key Management","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Access Control","count":2},{"language":"default","tag":"BRK Execution","count":2},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"SDK Reference","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/check-acl","slug":"/api-reference/endpoint/check-acl","pageMetadata":{"title":"Check BRK ACL","api":"POST /check_brx_acl","description":"Retrieves the access control list for a BRK","href":"/api-reference/endpoint/check-acl"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieves the access control list for a BRK\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(ParamField,{body:`brxId`,type:`string`,required:true,id:`param-brx-id`,children:_jsx(_components.p,{children:`The ID of the BRK to check ACL for`})}),`\n`,_jsx(Heading,{level:`3`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brxId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"brk-12345678-90ab-cdef-1234-567890abcdef\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`getBrxACLResponse`,type:`object`,id:`param-get-brx-acl-response`,children:_jsx(Expandable,{title:`properties`,children:_jsx(ResponseField,{name:`brxs`,type:`object`,id:`param-brxs`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ResponseField,{name:`isPublic`,type:`boolean`,id:`param-is-public`,children:_jsx(_components.p,{children:`Indicates whether the BRK is public (visible to all users) or private (visible only to specified users)`})}),_jsx(ResponseField,{name:`isClone`,type:`boolean`,id:`param-is-clone`,children:_jsx(_components.p,{children:`Indicates whether the BRK can be cloned by other users`})}),_jsx(ResponseField,{name:`brxId`,type:`string`,id:`param-brx-id-1`,children:_jsx(_components.p,{children:`The ID of the BRK`})}),_jsxs(ResponseField,{name:`emails`,type:`array`,id:`param-emails`,children:[_jsx(_components.p,{children:`Array of user email addresses and their permission levels`}),_jsxs(Expandable,{title:`items`,children:[_jsx(ResponseField,{name:`email`,type:`string`,id:`param-email`,children:_jsx(_components.p,{children:`Email address of the user`})}),_jsx(ResponseField,{name:`permission`,type:`number`,id:`param-permission`,children:_jsx(_components.p,{children:`Permission level for the user. 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)`})})]})]})]})})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-response-private-brk`,children:`Example Response (Private BRK)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`23`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`23`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"getBrxACLResponse\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brxs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isPublic\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isClone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brxId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"brk-12345678-90ab-cdef-1234-567890abcdef\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"emails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"owner@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"permission\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"editor@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"permission\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"viewer@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"permission\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`0`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-response-public-brk`,children:`Example Response (Public BRK)`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`15`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`15`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"getBrxACLResponse\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brxs\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isPublic\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"isClone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"brxId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"brk-12345678-90ab-cdef-1234-567890abcdef\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"emails\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"owner@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"permission\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`error-codes`,children:`Error Codes`}),`\n`,_jsx(ResponseField,{name:`400`,type:`object`,id:`param-400`,children:_jsx(_components.p,{children:`Bad Request - The request was malformed or missing required parameters`})}),`\n`,_jsx(ResponseField,{name:`401`,type:`object`,id:`param-401`,children:_jsx(_components.p,{children:`Unauthorized - Authentication credentials are missing or invalid`})}),`\n`,_jsx(ResponseField,{name:`403`,type:`object`,id:`param-403`,children:_jsx(_components.p,{children:`Forbidden - The authenticated user does not have permission to check the ACL for the requested BRK`})}),`\n`,_jsx(ResponseField,{name:`404`,type:`object`,id:`param-404`,children:_jsx(_components.p,{children:`Not Found - The requested BRK does not exist`})}),`\n`,_jsx(ResponseField,{name:`500`,type:`object`,id:`param-500`,children:_jsx(_components.p,{children:`Internal Server Error - An unexpected error occurred on the server`})}),`\n`,_jsx(Heading,{level:`2`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`You must have at least viewer permissions for the BRK to access its ACL.`}),`\n`,_jsxs(_components.li,{children:[`The response includes the visibility of the BRK (`,_jsx(_components.code,{children:`isPublic`}),`), whether it can be cloned (`,_jsx(_components.code,{children:`isClone`}),`), and the list of users who have access to it along with their permission levels.`]}),`\n`,_jsxs(_components.li,{children:[`Permission levels:`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`0: Viewer (can view and execute the BRK)`}),`\n`,_jsx(_components.li,{children:`1: Editor (can view, execute, and edit the BRK)`}),`\n`,_jsx(_components.li,{children:`2: Owner (can view, execute, edit, and delete the BRK, as well as manage permissions)`}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`To update the ACL for a BRK, use the `,_jsx(_components.a,{href:`/api-reference/endpoint/update-acl`,children:`Update BRK ACL`}),` endpoint.`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Check BRK ACL","api":"POST /check_brx_acl","description":"Retrieves the access control list for a BRK","href":"/api-reference/endpoint/check-acl"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":2,"children":[{"title":"Example Request","slug":"example-request","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[{"title":"Example Response (Private BRK)","slug":"example-response-private-brk","depth":3,"children":[]},{"title":"Example Response (Public BRK)","slug":"example-response-public-brk","depth":3,"children":[]}]},{"title":"Error Codes","slug":"error-codes","depth":2,"children":[]},{"title":"Notes","slug":"notes","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Check BRK ACL","path":"/check_brx_acl","method":"post","request":{"security":[],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"brxId":[{"type":"string","description":"The ID of the BRK to check ACL for","required":true}]}}],"examples":{"example":{"value":{"brxId":"\u003cstring>"}}}}}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"400":[{"type":"object","properties":{},"description":"Bad Request - The request was malformed or missing required parameters"}],"401":[{"type":"object","properties":{},"description":"Unauthorized - Authentication credentials are missing or invalid"}],"403":[{"type":"object","properties":{},"description":"Forbidden - The authenticated user does not have permission to check the ACL for the requested BRK"}],"404":[{"type":"object","properties":{},"description":"Not Found - The requested BRK does not exist"}],"500":[{"type":"object","properties":{},"description":"Internal Server Error - An unexpected error occurred on the server"}],"getBrxACLResponse":[{"type":"object","properties":{"brxs":[{"type":"object","properties":{"isPublic":[{"type":"boolean","description":"Indicates whether the BRK is public (visible to all users) or private (visible only to specified users)"}],"isClone":[{"type":"boolean","description":"Indicates whether the BRK can be cloned by other users"}],"brxId":[{"type":"string","description":"The ID of the BRK"}],"emails":[{"type":"array","items":[{"type":"object","properties":{"email":[{"type":"string","description":"Email address of the user"}],"permission":[{"type":"number","description":"Permission level for the user. 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)"}]}}],"description":"Array of user email addresses and their permission levels"}]}}]}}]}}],"examples":{"example":{"value":{"400":{},"401":{},"403":{},"404":{},"500":{},"getBrxACLResponse":{"brxs":{"isPublic":true,"isClone":true,"brxId":"\u003cstring>","emails":[{"email":"\u003cstring>","permission":123}]}}}}}}}},"deprecated":false}},"jsLinks":["/_mintlify/custom/brx/5a0d712819755478/api-reference/openapi-components/compile-openapi.js"],"subdomain":"brx","siteName":"DOCS","title":"Check BRK ACL - DOCS","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T04:52:38.228Z","originalFileLocation":"api-reference/endpoint/check-acl.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves the access control list for a BRK\">\u003cmeta data-mint-head name=\"application-name\" content=\"DOCS\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Check BRK ACL - DOCS\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the access control list for a BRK\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DOCS\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.brx.ai/api-reference/endpoint/check-acl\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://brx.mintlify.site/_mintlify/api/og/v2?division=Access+Control\u0026amp;title=Check+BRK+ACL\u0026amp;description=Retrieves+the+access+control+list+for+a+BRK\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=df0257b428046fd59ef0348374cd569c9a3967c01a80e402637fe3e1a3678531\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Check BRK ACL - DOCS\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the access control list for a BRK\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://brx.mintlify.site/_mintlify/api/og/v2?division=Access+Control\u0026amp;title=Check+BRK+ACL\u0026amp;description=Retrieves+the+access+control+list+for+a+BRK\u0026amp;theme=0d5c199c94800372ac1d0c6f\u0026amp;signature=df0257b428046fd59ef0348374cd569c9a3967c01a80e402637fe3e1a3678531\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/brx/TNbIH6kCitc6p_xn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DOCS\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#36332e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.brx.ai/api-reference/endpoint/check-acl\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/check-acl.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.brx.ai/#organization\",\"name\":\"DOCS\",\"url\":\"https://docs.brx.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brx/zBGB5rG4WcaJLc2G/logo/brx_logo_dark_big.svg?fit=max\u0026auto=format\u0026n=zBGB5rG4WcaJLc2G\u0026q=85\u0026s=192d2c11b5bf54ed66b86c20da9ce796\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.brx.ai#website\",\"name\":\"DOCS\",\"url\":\"https://docs.brx.ai\",\"publisher\":{\"@id\":\"https://docs.brx.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.brx.ai/api-reference/endpoint/check-acl#webpage\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/check-acl\",\"name\":\"Check BRK ACL\",\"description\":\"Retrieves the access control list for a BRK\",\"dateModified\":\"2026-01-07T04:52:38.228Z\",\"isPartOf\":{\"@id\":\"https://docs.brx.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/check-acl#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.brx.ai/api-reference/endpoint/check-acl#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Access Control\",\"item\":\"https://docs.brx.ai/api-reference/endpoint/update-acl\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Check BRK ACL\",\"item\":\"https://docs.brx.ai/api-reference/endpoint/check-acl\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.brx.ai/api-reference/endpoint/check-acl#apireference\",\"headline\":\"Check BRK ACL\",\"name\":\"Check BRK ACL\",\"description\":\"Retrieves the access control list for a BRK\",\"url\":\"https://docs.brx.ai/api-reference/endpoint/check-acl\",\"mainEntityOfPage\":{\"@id\":\"https://docs.brx.ai/api-reference/endpoint/check-acl#webpage\"},\"dateModified\":\"2026-01-07T04:52:38.228Z\",\"publisher\":{\"@id\":\"https://docs.brx.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.brx.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DOCS\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"DOCS","nav":{"global":{"anchors":[{"anchor":"Documentation","href":"https://predocs.brx.ai","icon":"book-open-cover"},{"anchor":"Community","href":"https://join.slack.com/t/brx-communityslack/shared_invite/zt-2vfndoyuv-FTxv0Wc2CzpfO6TH3VHpkg","icon":"slack"},{"anchor":"Github","href":"https://github.com/brx-ai","icon":"github"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/Get Started/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":null,"href":"/api-reference/introduction"}]},{"group":"BRK Management","pages":[{"title":"Get BRK Schema","openapi":"POST /schema_from_id","href":"/api-reference/endpoint/get"},{"title":"Create BRK","openapi":"POST /modify_brx","href":"/api-reference/endpoint/create"},{"title":"List","href":"/api-reference/endpoint/list"},{"title":"List private","href":"/api-reference/endpoint/list-private"},{"title":"Get Raw BRK","api":"POST /raw_brx","href":"/api-reference/endpoint/raw"}]},{"group":"BRK Execution","pages":[{"title":"Execute BRK","api":"POST /execute_brx","href":"/api-reference/endpoint/execute"},{"title":"Validate BRK","api":"POST /validate_brx","href":"/api-reference/endpoint/validate"}]},{"group":"Access Control","pages":[{"title":"Update BRK ACL","api":"POST /update_brx_acl","description":"Updates the access control list for a BRK","href":"/api-reference/endpoint/update-acl"},{"title":"Check BRK ACL","api":"POST /check_brx_acl","href":"/api-reference/endpoint/check-acl"}]},{"group":"API Key Management","pages":[{"title":"Generate API Key","api":"POST /generate_api_brx","description":"Generates a new API key for the authenticated user","href":"/api-reference/endpoint/generate-key"},{"title":"List API Keys","api":"POST /list_api_brx","href":"/api-reference/endpoint/list-keys"},{"title":"Delete API Key","api":"POST /delete_api_brx","href":"/api-reference/endpoint/delete-key"}]}]}]},"basePath":"","title":"Check BRK ACL - DOCS","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js"]}