Custom Roles
Update resource scopes
Replace all resource scopes for a custom role
PUT
/
api
/
v1
/
custom_roles
/
{id}
/
update_resource_scopes
Update resource scopes
curl --request PUT \
--url https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"resource_scopes": [
{
"resource_type": "<string>",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
"<string>"
]
}
]
}
'import requests
url = "https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes"
payload = { "resource_scopes": [
{
"resource_type": "<string>",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": ["<string>"]
}
] }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource_scopes: [
{
resource_type: '<string>',
resource_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
actions: ['<string>']
}
]
})
};
fetch('https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes', 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.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes",
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([
'resource_scopes' => [
[
'resource_type' => '<string>',
'resource_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'actions' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes"
payload := strings.NewReader("{\n \"resource_scopes\": [\n {\n \"resource_type\": \"<string>\",\n \"resource_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resource_scopes\": [\n {\n \"resource_type\": \"<string>\",\n \"resource_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_scopes\": [\n {\n \"resource_type\": \"<string>\",\n \"resource_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"resource_scopes": "<array>"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Account ID is required (provide account-id header or account_id in URL)"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "INVALID_TOKEN",
"message": "Invalid token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Custom role not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}Authorizations
API access token authentication
Body
application/json
Show child attributes
Show child attributes
⌘I
Update resource scopes
curl --request PUT \
--url https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"resource_scopes": [
{
"resource_type": "<string>",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
"<string>"
]
}
]
}
'import requests
url = "https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes"
payload = { "resource_scopes": [
{
"resource_type": "<string>",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": ["<string>"]
}
] }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
resource_scopes: [
{
resource_type: '<string>',
resource_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
actions: ['<string>']
}
]
})
};
fetch('https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes', 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.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes",
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([
'resource_scopes' => [
[
'resource_type' => '<string>',
'resource_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'actions' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes"
payload := strings.NewReader("{\n \"resource_scopes\": [\n {\n \"resource_type\": \"<string>\",\n \"resource_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"resource_scopes\": [\n {\n \"resource_type\": \"<string>\",\n \"resource_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evoai.app/api/v1/custom_roles/{id}/update_resource_scopes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"resource_scopes\": [\n {\n \"resource_type\": \"<string>\",\n \"resource_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"actions\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"resource_scopes": "<array>"
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z"
},
"message": "<string>"
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Account ID is required (provide account-id header or account_id in URL)"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "INVALID_TOKEN",
"message": "Invalid token"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "NOT_FOUND",
"message": "Custom role not found"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}{
"success": false,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred"
},
"meta": {
"timestamp": "2024-01-15T10:30:00Z",
"path": "/api/v1/custom_roles/{id}/update_resource_scopes",
"method": "PUT"
}
}