Set a role assignment
curl --request PUT \
--url https://api.ara.so/v3/organizations/{orgId}/roles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_id": "usr_4a1b",
"role": "pro"
}
'import requests
url = "https://api.ara.so/v3/organizations/{orgId}/roles"
payload = {
"user_id": "usr_4a1b",
"role": "pro"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_id: 'usr_4a1b', role: 'pro'})
};
fetch('https://api.ara.so/v3/organizations/{orgId}/roles', 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.ara.so/v3/organizations/{orgId}/roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => 'usr_4a1b',
'role' => 'pro'
]),
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.ara.so/v3/organizations/{orgId}/roles"
payload := strings.NewReader("{\n \"user_id\": \"usr_4a1b\",\n \"role\": \"pro\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.ara.so/v3/organizations/{orgId}/roles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"usr_4a1b\",\n \"role\": \"pro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ara.so/v3/organizations/{orgId}/roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"usr_4a1b\",\n \"role\": \"pro\"\n}"
response = http.request(request)
puts response.read_body{
"user_id": "<string>",
"role": "pro",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "session_not_found"
}Assigns a role to a member.
Scope:org:writePUT
/
v3
/
organizations
/
{orgId}
/
roles
Set a role assignment
curl --request PUT \
--url https://api.ara.so/v3/organizations/{orgId}/roles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_id": "usr_4a1b",
"role": "pro"
}
'import requests
url = "https://api.ara.so/v3/organizations/{orgId}/roles"
payload = {
"user_id": "usr_4a1b",
"role": "pro"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({user_id: 'usr_4a1b', role: 'pro'})
};
fetch('https://api.ara.so/v3/organizations/{orgId}/roles', 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.ara.so/v3/organizations/{orgId}/roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'user_id' => 'usr_4a1b',
'role' => 'pro'
]),
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.ara.so/v3/organizations/{orgId}/roles"
payload := strings.NewReader("{\n \"user_id\": \"usr_4a1b\",\n \"role\": \"pro\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.ara.so/v3/organizations/{orgId}/roles")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"usr_4a1b\",\n \"role\": \"pro\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ara.so/v3/organizations/{orgId}/roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user_id\": \"usr_4a1b\",\n \"role\": \"pro\"\n}"
response = http.request(request)
puts response.read_body{
"user_id": "<string>",
"role": "pro",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "session_not_found"
}Authorizations
Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, plugins:read, secrets:read, secrets:write, sessions:read, knowledge:read, repos:read, repos:write, reviews:read, reviews:write, analytics:read, org:read, org:write, attachments:read, attachments:write, plugins:write, guardrails:read, guardrails:write.
Path Parameters
Organization id or slug. Resolve it with GET /v3/self.
Body
application/json
⌘I