Skip to main content
PATCH
/
v1
/
role
/
{role_id}
Partially update role
curl --request PATCH \
  --url https://api.braintrust.dev/v1/role/{role_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "add_member_permissions": [
    {}
  ],
  "remove_member_permissions": [
    {}
  ],
  "add_member_roles": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "remove_member_roles": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
import requests

url = "https://api.braintrust.dev/v1/role/{role_id}"

payload = {
    "description": "<string>",
    "name": "<string>",
    "add_member_permissions": [{}],
    "remove_member_permissions": [{}],
    "add_member_roles": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "remove_member_roles": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    name: '<string>',
    add_member_permissions: [{}],
    remove_member_permissions: [{}],
    add_member_roles: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    remove_member_roles: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
  })
};

fetch('https://api.braintrust.dev/v1/role/{role_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.braintrust.dev/v1/role/{role_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'name' => '<string>',
    'add_member_permissions' => [
        [
                
        ]
    ],
    'remove_member_permissions' => [
        [
                
        ]
    ],
    'add_member_roles' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'remove_member_roles' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.braintrust.dev/v1/role/{role_id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"add_member_permissions\": [\n    {}\n  ],\n  \"remove_member_permissions\": [\n    {}\n  ],\n  \"add_member_roles\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_member_roles\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.braintrust.dev/v1/role/{role_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"add_member_permissions\": [\n    {}\n  ],\n  \"remove_member_permissions\": [\n    {}\n  ],\n  \"add_member_roles\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_member_roles\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.braintrust.dev/v1/role/{role_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"add_member_permissions\": [\n    {}\n  ],\n  \"remove_member_permissions\": [\n    {}\n  ],\n  \"add_member_roles\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"remove_member_roles\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "deleted_at": "2023-11-07T05:31:56Z",
  "member_permissions": [
    {}
  ],
  "member_roles": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
"<string>"
"<string>"
"<string>"
"<string>"
"<string>"

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.

Path Parameters

​
role_id
string<uuid>
required

Role id

Body

application/json

Fields to update

​
description
string | null

Textual description of the role

​
name
string | null

Name of the role

Minimum string length: 1
​
add_member_permissions
object[] | null

A list of permissions to add to the role

​
remove_member_permissions
object[] | null

A list of permissions to remove from the role

​
add_member_roles
string<uuid>[] | null

A list of role IDs to add to the role's inheriting-from set

​
remove_member_roles
string<uuid>[] | null

A list of role IDs to remove from the role's inheriting-from set

Response

Returns the role object

A role is a collection of permissions which can be granted as part of an ACL

Roles can consist of individual permissions, as well as a set of roles they inherit from

​
id
string<uuid>
required

Unique identifier for the role

​
name
string
required

Name of the role

​
org_id
string<uuid> | null

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_id
string<uuid> | null

Identifies the user who created the role

​
created
string<date-time> | null

Date of role creation

​
description
string | null

Textual description of the role

​
deleted_at
string<date-time> | null

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

​
member_permissions
object[] | null

(permission, restrict_object_type) tuples which belong to this role

​
member_roles
string<uuid>[] | null

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