Get User Group Permissions
curl --request GET \
--url https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/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://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
"basic"
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}User Groups
Get User Group Permissions
GET
/
manage
/
admin
/
user-group
/
{user_group_id}
/
permissions
Get User Group Permissions
curl --request GET \
--url https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/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://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.onyx.app/api/manage/admin/user-group/{user_group_id}/permissions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
"basic"
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Business Edition FeatureThis feature requires a Business or Enterprise plan. View plans
or contact sales to learn more.
Required permission: Manage Groups (
manage:user_groups), or Admin (admin).Authorizations
Authorization header with Bearer token
Path Parameters
Query Parameters
Response
Successful Response
Permission tokens for group-based authorization and PAT scoping. full_admin_panel_access is an override — if present, any permission check passes.
The read:/write: "API-surface scopes" are coarser than the capability tokens: they name request surfaces (search, chat, admin-read) rather than admin capabilities. They are implied by basic / admin (so they're never granted directly to a group) and exist primarily to scope Personal Access Tokens.
Available options:
basic, read:connectors, read:document_sets, read:agents, read:users, read:user_groups, read:search, read:chat, write:chat, read:admin, generate:image, use:llm_gateway, add:agents, manage:agents, manage:document_sets, manage:connectors, manage:llms, read:agent_analytics, manage:actions, manage:skills, read:query_history, manage:user_groups, create:user_api_keys, manage:service_account_api_keys, manage:bots, craft_sandbox, admin Was this page helpful?