Skip to main content
GET
/
v1
/
acl
List acls
curl --request GET \
  --url https://api.braintrust.dev/v1/acl \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object_type": "organization",
      "object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "permission": "create",
      "restrict_object_type": "organization",
      "role_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "_object_org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Query Parameters

​
limit
integer | null

Limit the number of objects to return

Required range: x >= 0
​
starting_after
string<uuid>

Pagination cursor id.

For example, if the final item in the last page you fetched had an id of foo, pass starting_after=foo to fetch the next page. Note: you may only pass one of starting_after and ending_before

​
ending_before
string<uuid>

Pagination cursor id.

For example, if the initial item in the last page you fetched had an id of foo, pass ending_before=foo to fetch the previous page. Note: you may only pass one of starting_after and ending_before

​
ids

Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times

​
object_type
enum<string>
required

The object type that the ACL applies to

Available options:
organization,
project,
experiment,
dataset,
prompt,
prompt_session,
group,
role,
org_member,
project_log,
org_project
​
object_id
string<uuid>
required

The id of the object the ACL applies to

​
user_id
string<uuid>

Id of the user the ACL applies to. Exactly one of user_id and group_id will be provided

​
group_id
string<uuid>

Id of the group the ACL applies to. Exactly one of user_id and group_id will be provided

​
permission
enum<string>

Each permission permits a certain type of operation on an object in the system

Permissions can be assigned to to objects on an individual basis, or grouped into roles

Available options:
create,
read,
update,
delete,
create_acls,
read_acls,
update_acls,
delete_acls
​
restrict_object_type
enum<string>

The object type that the ACL applies to

Available options:
organization,
project,
experiment,
dataset,
prompt,
prompt_session,
group,
role,
org_member,
project_log,
org_project
​
role_id
string<uuid>

Id of the role the ACL grants. Exactly one of permission and role_id will be provided

Response

Returns a list of acl objects

​
objects
object[]
required

A list of acl objects