curl --request PUT \
--url https://api.edenai.run/v3/manage/roles/{role_id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"permissions": [
"<string>"
],
"description": "",
"guardrail_id": 123
}
'import requests
url = "https://api.edenai.run/v3/manage/roles/{role_id}/"
payload = {
"name": "<string>",
"permissions": ["<string>"],
"description": "",
"guardrail_id": 123
}
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({
name: '<string>',
permissions: ['<string>'],
description: '',
guardrail_id: 123
})
};
fetch('https://api.edenai.run/v3/manage/roles/{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.edenai.run/v3/manage/roles/{role_id}/",
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([
'name' => '<string>',
'permissions' => [
'<string>'
],
'description' => '',
'guardrail_id' => 123
]),
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.edenai.run/v3/manage/roles/{role_id}/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"description\": \"\",\n \"guardrail_id\": 123\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.edenai.run/v3/manage/roles/{role_id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"description\": \"\",\n \"guardrail_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.edenai.run/v3/manage/roles/{role_id}/")
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 \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"description\": \"\",\n \"guardrail_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"guardrail_id": 123,
"description": "<string>",
"is_system": true,
"permissions": [
"<string>"
]
}Replace a role
Replaces a custom role as a whole: its name, description, permissions and guardrail. The change applies at once to every member holding the role. System roles cannot be changed (403). A management key can only grant member management: a role with org:manage, billing:manage or api_keys:manage is refused (403). Requires the manage:write scope.
curl --request PUT \
--url https://api.edenai.run/v3/manage/roles/{role_id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"permissions": [
"<string>"
],
"description": "",
"guardrail_id": 123
}
'import requests
url = "https://api.edenai.run/v3/manage/roles/{role_id}/"
payload = {
"name": "<string>",
"permissions": ["<string>"],
"description": "",
"guardrail_id": 123
}
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({
name: '<string>',
permissions: ['<string>'],
description: '',
guardrail_id: 123
})
};
fetch('https://api.edenai.run/v3/manage/roles/{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.edenai.run/v3/manage/roles/{role_id}/",
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([
'name' => '<string>',
'permissions' => [
'<string>'
],
'description' => '',
'guardrail_id' => 123
]),
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.edenai.run/v3/manage/roles/{role_id}/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"description\": \"\",\n \"guardrail_id\": 123\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.edenai.run/v3/manage/roles/{role_id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"description\": \"\",\n \"guardrail_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.edenai.run/v3/manage/roles/{role_id}/")
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 \"name\": \"<string>\",\n \"permissions\": [\n \"<string>\"\n ],\n \"description\": \"\",\n \"guardrail_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"guardrail_id": 123,
"description": "<string>",
"is_system": true,
"permissions": [
"<string>"
]
}Authorizations
Body
A custom role. permissions are codes from GET /v3/manage/permissions; guardrail_id
applies one of the organization's guardrails to everyone holding the role (null for none).
Names are unique, and cannot reuse a system role's name.
Response
A role. System roles (is_system: true) are shared by every organization and cannot be
changed; the others are the organization's own. guardrail_id is the guardrail that applies
to the role's members, or null.