BRbraintrustdata
Roles

Get role

Changed on

Get a role object by its id

get/v1/role/{role_id}

Request

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

Path parameters

role_idstring uuid required

Role id

Response

Returns the role object

idstring uuid required

Unique identifier for the role

org_idstring uuid nullable

Unique id for the organization that the role belongs under

A null org_id indicates a system role, which may be assigned to anybody and inherited by any other role, but cannot be edited.

It is forbidden to change the org after creating a role

user_idstring uuid nullable

Identifies the user who created the role

createdstring date-time nullable

Date of role creation

namestring required

Name of the role

descriptionstring nullable

Textual description of the role

deleted_atstring date-time nullable

Date of role deletion, or null if the role is still active

member_rolesstring[] nullable

Ids of the roles this role inherits from

An inheriting role has all the permissions contained in its member roles, as well as all of their inherited permissions

Changes

  • 8f5039399f77Revision changes
    • 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

      removed the ai_secret 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 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 role 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