BRbraintrustdata
Acls

List org ACLs

Changed on

List all ACLs in the org. This query requires the caller to have read_acls permission at the organization level

get/v1/acl/list_org

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Query parameters

limitinteger nullable

Limit the number of objects to return

string uuid
OR
string[]
starting_afterstring 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_beforestring 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

object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' | 'org_audit_logs' | 'project_group' | 'project_group_projects' | 'ai_secret' | 'org_ai_secret' | 'org_account'

The object type that the ACL applies to

object_idstring uuid

The id of the object the ACL applies to

user_idstring uuid

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

group_idstring uuid

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

permission'create' | 'read' | 'update' | 'delete' | 'create_acls' | 'read_acls' | 'update_acls' | 'delete_acls'

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

restrict_object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' | 'org_audit_logs' | 'project_group' | 'project_group_projects' | 'ai_secret' | 'org_ai_secret' | 'org_account'

The object type that the ACL applies to

role_idstring uuid

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

org_namestring

Filter search results to within a particular organization

Response

A list of ACLs

idstring uuid required

Unique identifier for the acl

object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' | 'org_audit_logs' | 'project_group' | 'project_group_projects' | 'ai_secret' | 'org_ai_secret' | 'org_account' required

The object type that the ACL applies to

object_idstring uuid required

The id of the object the ACL applies to

user_idstring uuid nullable

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

group_idstring uuid nullable

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

permission'create' | 'read' | 'update' | 'delete' | 'create_acls' | 'read_acls' | 'update_acls' | 'delete_acls'

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

restrict_object_type'organization' | 'project' | 'experiment' | 'dataset' | 'prompt' | 'prompt_session' | 'group' | 'role' | 'org_member' | 'project_log' | 'org_project' | 'org_audit_logs' | 'project_group' | 'project_group_projects' | 'ai_secret' | 'org_ai_secret' | 'org_account'

The object type that the ACL applies to

role_idstring uuid nullable

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

_object_org_idstring uuid required

The organization the ACL's referred object belongs to

createdstring date-time nullable

Date of acl creation

Changes

  • 8f5039399f77Revision changes
    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from string to no type for status

    • info

      added subschema #2 to the / response property anyOf list for the response status

    • info

      added subschema #2 to the / response property anyOf list for the response status

    • info

      removed the ai_secret enum value from the / response property for the response status

    • info

      removed the create enum value from the / response property for the response status

    • info

      removed the create_acls enum value from the / response property for the response status

    • info

      removed the dataset enum value from the / response property for the response status

    • info

      removed the delete enum value from the / response property for the response status

    • info

      removed the delete_acls enum value from the / response property for the response status

    • info

      removed the experiment enum value from the / response property for the response status

    • info

      removed the group enum value from the / response property for the response status

    • info

      removed the org_account enum value from the / response property for the response status

    • info

      removed the org_ai_secret enum value from the / response property for the response status

    • info

      removed the org_audit_logs enum value from the / response property for the response status

    • info

      removed the org_member enum value from the / response property for the response status

    • info

      removed the org_project enum value from the / response property for the response status

    • info

      removed the organization enum value from the / response property for the response status

    • info

      removed the project enum value from the / response property for the response status

    • info

      removed the project_group enum value from the / response property for the response status

    • info

      removed the project_group_projects enum value from the / response property for the response status

    • info

      removed the project_log enum value from the / response property for the response status

    • info

      removed the prompt enum value from the / response property for the response status

    • info

      removed the prompt_session enum value from the / response property for the response status

    • info

      removed the read enum value from the / response property for the response status

    • info

      removed the read_acls enum value from the / response property for the response status

    • info

      removed the role enum value from the / response property for the response status

    • info

      removed the update enum value from the / response property for the response status

    • info

      removed the update_acls enum value from the / response property for the response status

  • 877ab1fd2a22Revision changes
    • warning

      added the new project_group_projects enum value to the / response property for the response status

    • warning

      added the new project_group_projects enum value to the / response property for the response status

    • info

      added the new enum value project_group_projects to the query request parameter object_type

    • info

      added the new enum value project_group_projects to the query request parameter restrict_object_type