{ "opencollection": "1.0.0", "info": { "name": "Braintrust Acls API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Acls", "type": "folder" }, "items": [ { "info": { "name": "List acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/acl", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of objects to return" }, { "name": "starting_after", "value": "", "type": "query", "description": "Pagination cursor id.\n\nFor 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`" }, { "name": "ending_before", "value": "", "type": "query", "description": "Pagination cursor id.\n\nFor 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`" }, { "name": "ids", "value": "", "type": "query", "description": "Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times" }, { "name": "object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the ACL applies to" }, { "name": "user_id", "value": "", "type": "query", "description": "Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "group_id", "value": "", "type": "query", "description": "Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "permission", "value": "", "type": "query", "description": "Each permission permits a certain type of operation on an object in the system\n\nPermissions can be assigned to to objects on an individual basis, or grouped into roles" }, { "name": "restrict_object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "role_id", "value": "", "type": "query", "description": "Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List out all acls. The acls are sorted by creation date, with the most recently-created acls coming first" }, { "info": { "name": "Create acl", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/acl", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new acl. If there is an existing acl with the same contents as the one specified in the request, will return the existing acl unmodified" }, { "info": { "name": "Delete single acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/acl", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a single acl" }, { "info": { "name": "Get acl", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/acl/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path", "description": "Acl id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an acl object by its id" }, { "info": { "name": "Delete acl", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.braintrust.dev/v1/acl/:acl_id", "params": [ { "name": "acl_id", "value": "", "type": "path", "description": "Acl id" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an acl object by its id" }, { "info": { "name": "Batch update acls", "type": "http" }, "http": { "method": "POST", "url": "https://api.braintrust.dev/v1/acl/batch_update", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Batch update acls. This operation is idempotent, so adding acls which already exist will have no effect, and removing acls which do not exist will have no effect." }, { "info": { "name": "List org acls", "type": "http" }, "http": { "method": "GET", "url": "https://api.braintrust.dev/v1/acl/list_org", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Limit the number of objects to return" }, { "name": "ids", "value": "", "type": "query", "description": "Filter search results to a particular set of object IDs. To specify a list of IDs, include the query param multiple times" }, { "name": "starting_after", "value": "", "type": "query", "description": "Pagination cursor id.\n\nFor 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`" }, { "name": "ending_before", "value": "", "type": "query", "description": "Pagination cursor id.\n\nFor 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`" }, { "name": "object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "object_id", "value": "", "type": "query", "description": "The id of the object the ACL applies to" }, { "name": "user_id", "value": "", "type": "query", "description": "Id of the user the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "group_id", "value": "", "type": "query", "description": "Id of the group the ACL applies to. Exactly one of `user_id` and `group_id` will be provided" }, { "name": "permission", "value": "", "type": "query", "description": "Each permission permits a certain type of operation on an object in the system\n\nPermissions can be assigned to to objects on an individual basis, or grouped into roles" }, { "name": "restrict_object_type", "value": "", "type": "query", "description": "The object type that the ACL applies to" }, { "name": "role_id", "value": "", "type": "query", "description": "Id of the role the ACL grants. Exactly one of `permission` and `role_id` will be provided" }, { "name": "org_name", "value": "", "type": "query", "description": "Filter search results to within a particular organization" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all acls in the org. This query requires the caller to have `read_acls` permission at the organization level" } ] } ], "bundled": true }