cURL
curl --request PUT \
--url https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}
'import requests
url = "https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions"
payload = { "permissions": [
{
"target_ids": ["a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1", "8294e9c9-deb6-48e9-9c99-da2a1e04a87f"],
"target_type": "RESOURCE",
"permission_name": "READ"
}
] }
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({
permissions: [
{
target_ids: ['a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1', '8294e9c9-deb6-48e9-9c99-da2a1e04a87f'],
target_type: 'RESOURCE',
permission_name: 'READ'
}
]
})
};
fetch('https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions', 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.opal.dev/v1/resources/{resource_id}/scoped-role-permissions",
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([
'permissions' => [
[
'target_ids' => [
'a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1',
'8294e9c9-deb6-48e9-9c99-da2a1e04a87f'
],
'target_type' => 'RESOURCE',
'permission_name' => 'READ'
]
]
]),
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.opal.dev/v1/resources/{resource_id}/scoped-role-permissions"
payload := strings.NewReader("{\n \"permissions\": [\n {\n \"target_ids\": [\n \"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1\",\n \"8294e9c9-deb6-48e9-9c99-da2a1e04a87f\"\n ],\n \"target_type\": \"RESOURCE\",\n \"permission_name\": \"READ\"\n }\n ]\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.opal.dev/v1/resources/{resource_id}/scoped-role-permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"permissions\": [\n {\n \"target_ids\": [\n \"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1\",\n \"8294e9c9-deb6-48e9-9c99-da2a1e04a87f\"\n ],\n \"target_type\": \"RESOURCE\",\n \"permission_name\": \"READ\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions")
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 \"permissions\": [\n {\n \"target_ids\": [\n \"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1\",\n \"8294e9c9-deb6-48e9-9c99-da2a1e04a87f\"\n ],\n \"target_type\": \"RESOURCE\",\n \"permission_name\": \"READ\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}Sets all the scoped role permissions on an OPAL_SCOPED_ROLE resource.
PUT
/
resources
/
{resource_id}
/
scoped-role-permissions
cURL
curl --request PUT \
--url https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}
'import requests
url = "https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions"
payload = { "permissions": [
{
"target_ids": ["a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1", "8294e9c9-deb6-48e9-9c99-da2a1e04a87f"],
"target_type": "RESOURCE",
"permission_name": "READ"
}
] }
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({
permissions: [
{
target_ids: ['a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1', '8294e9c9-deb6-48e9-9c99-da2a1e04a87f'],
target_type: 'RESOURCE',
permission_name: 'READ'
}
]
})
};
fetch('https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions', 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.opal.dev/v1/resources/{resource_id}/scoped-role-permissions",
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([
'permissions' => [
[
'target_ids' => [
'a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1',
'8294e9c9-deb6-48e9-9c99-da2a1e04a87f'
],
'target_type' => 'RESOURCE',
'permission_name' => 'READ'
]
]
]),
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.opal.dev/v1/resources/{resource_id}/scoped-role-permissions"
payload := strings.NewReader("{\n \"permissions\": [\n {\n \"target_ids\": [\n \"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1\",\n \"8294e9c9-deb6-48e9-9c99-da2a1e04a87f\"\n ],\n \"target_type\": \"RESOURCE\",\n \"permission_name\": \"READ\"\n }\n ]\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.opal.dev/v1/resources/{resource_id}/scoped-role-permissions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"permissions\": [\n {\n \"target_ids\": [\n \"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1\",\n \"8294e9c9-deb6-48e9-9c99-da2a1e04a87f\"\n ],\n \"target_type\": \"RESOURCE\",\n \"permission_name\": \"READ\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opal.dev/v1/resources/{resource_id}/scoped-role-permissions")
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 \"permissions\": [\n {\n \"target_ids\": [\n \"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1\",\n \"8294e9c9-deb6-48e9-9c99-da2a1e04a87f\"\n ],\n \"target_type\": \"RESOURCE\",\n \"permission_name\": \"READ\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"permissions": [
{
"target_ids": [
"a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
"8294e9c9-deb6-48e9-9c99-da2a1e04a87f"
],
"target_type": "RESOURCE",
"permission_name": "READ"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the resource whose scoped role permissions belong to. Must be of OPAL_SCOPED_ROLE resource type.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The role permissions that this Opal Scoped Role has.
Show child attributes
Show child attributes
Last modified on July 23, 2026
Was this page helpful?
⌘I