Create role
curl --request POST \
--url https://cloud.bytebeam.io/api/v1/roles \
--header 'Content-Type: application/json' \
--header 'x-bytebeam-api-key: <api-key>' \
--header 'x-bytebeam-tenant: <api-key>' \
--data '
{
"name": "<string>",
"permissions": {
"editFirmwares": true,
"viewFiles": true,
"editTenantSettings": true,
"homepage": "<string>",
"dashboardPermittedShareRoles": {},
"viewMetadataKeys": true,
"editMetadataKeys": true,
"editDeviceConfigs": true,
"editRoles": true,
"createDashboards": true,
"viewRoles": true,
"tables": {},
"allowCreatingDevices": true,
"allowedActions": {},
"editFiles": true,
"editUsers": true,
"showDeviceManagementTab": true,
"viewActionTypes": true,
"viewDeviceConfigs": true,
"editStreams": true,
"viewStreams": true,
"editActionTypes": true,
"allowMarkActionAsCompleted": true,
"showActionsTab": true,
"viewUsers": true,
"showDashboardsTab": true,
"viewMetadata": {},
"editMetadata": {},
"devices": {},
"viewFirmwares": true
}
}
'import requests
url = "https://cloud.bytebeam.io/api/v1/roles"
payload = {
"name": "<string>",
"permissions": {
"editFirmwares": True,
"viewFiles": True,
"editTenantSettings": True,
"homepage": "<string>",
"dashboardPermittedShareRoles": {},
"viewMetadataKeys": True,
"editMetadataKeys": True,
"editDeviceConfigs": True,
"editRoles": True,
"createDashboards": True,
"viewRoles": True,
"tables": {},
"allowCreatingDevices": True,
"allowedActions": {},
"editFiles": True,
"editUsers": True,
"showDeviceManagementTab": True,
"viewActionTypes": True,
"viewDeviceConfigs": True,
"editStreams": True,
"viewStreams": True,
"editActionTypes": True,
"allowMarkActionAsCompleted": True,
"showActionsTab": True,
"viewUsers": True,
"showDashboardsTab": True,
"viewMetadata": {},
"editMetadata": {},
"devices": {},
"viewFirmwares": True
}
}
headers = {
"x-bytebeam-api-key": "<api-key>",
"x-bytebeam-tenant": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-bytebeam-api-key': '<api-key>',
'x-bytebeam-tenant': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
permissions: {
editFirmwares: true,
viewFiles: true,
editTenantSettings: true,
homepage: '<string>',
dashboardPermittedShareRoles: {},
viewMetadataKeys: true,
editMetadataKeys: true,
editDeviceConfigs: true,
editRoles: true,
createDashboards: true,
viewRoles: true,
tables: {},
allowCreatingDevices: true,
allowedActions: {},
editFiles: true,
editUsers: true,
showDeviceManagementTab: true,
viewActionTypes: true,
viewDeviceConfigs: true,
editStreams: true,
viewStreams: true,
editActionTypes: true,
allowMarkActionAsCompleted: true,
showActionsTab: true,
viewUsers: true,
showDashboardsTab: true,
viewMetadata: {},
editMetadata: {},
devices: {},
viewFirmwares: true
}
})
};
fetch('https://cloud.bytebeam.io/api/v1/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://cloud.bytebeam.io/api/v1/roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'permissions' => [
'editFirmwares' => true,
'viewFiles' => true,
'editTenantSettings' => true,
'homepage' => '<string>',
'dashboardPermittedShareRoles' => [
],
'viewMetadataKeys' => true,
'editMetadataKeys' => true,
'editDeviceConfigs' => true,
'editRoles' => true,
'createDashboards' => true,
'viewRoles' => true,
'tables' => [
],
'allowCreatingDevices' => true,
'allowedActions' => [
],
'editFiles' => true,
'editUsers' => true,
'showDeviceManagementTab' => true,
'viewActionTypes' => true,
'viewDeviceConfigs' => true,
'editStreams' => true,
'viewStreams' => true,
'editActionTypes' => true,
'allowMarkActionAsCompleted' => true,
'showActionsTab' => true,
'viewUsers' => true,
'showDashboardsTab' => true,
'viewMetadata' => [
],
'editMetadata' => [
],
'devices' => [
],
'viewFirmwares' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-bytebeam-api-key: <api-key>",
"x-bytebeam-tenant: <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://cloud.bytebeam.io/api/v1/roles"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"permissions\": {\n \"editFirmwares\": true,\n \"viewFiles\": true,\n \"editTenantSettings\": true,\n \"homepage\": \"<string>\",\n \"dashboardPermittedShareRoles\": {},\n \"viewMetadataKeys\": true,\n \"editMetadataKeys\": true,\n \"editDeviceConfigs\": true,\n \"editRoles\": true,\n \"createDashboards\": true,\n \"viewRoles\": true,\n \"tables\": {},\n \"allowCreatingDevices\": true,\n \"allowedActions\": {},\n \"editFiles\": true,\n \"editUsers\": true,\n \"showDeviceManagementTab\": true,\n \"viewActionTypes\": true,\n \"viewDeviceConfigs\": true,\n \"editStreams\": true,\n \"viewStreams\": true,\n \"editActionTypes\": true,\n \"allowMarkActionAsCompleted\": true,\n \"showActionsTab\": true,\n \"viewUsers\": true,\n \"showDashboardsTab\": true,\n \"viewMetadata\": {},\n \"editMetadata\": {},\n \"devices\": {},\n \"viewFirmwares\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-bytebeam-api-key", "<api-key>")
req.Header.Add("x-bytebeam-tenant", "<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.post("https://cloud.bytebeam.io/api/v1/roles")
.header("x-bytebeam-api-key", "<api-key>")
.header("x-bytebeam-tenant", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"permissions\": {\n \"editFirmwares\": true,\n \"viewFiles\": true,\n \"editTenantSettings\": true,\n \"homepage\": \"<string>\",\n \"dashboardPermittedShareRoles\": {},\n \"viewMetadataKeys\": true,\n \"editMetadataKeys\": true,\n \"editDeviceConfigs\": true,\n \"editRoles\": true,\n \"createDashboards\": true,\n \"viewRoles\": true,\n \"tables\": {},\n \"allowCreatingDevices\": true,\n \"allowedActions\": {},\n \"editFiles\": true,\n \"editUsers\": true,\n \"showDeviceManagementTab\": true,\n \"viewActionTypes\": true,\n \"viewDeviceConfigs\": true,\n \"editStreams\": true,\n \"viewStreams\": true,\n \"editActionTypes\": true,\n \"allowMarkActionAsCompleted\": true,\n \"showActionsTab\": true,\n \"viewUsers\": true,\n \"showDashboardsTab\": true,\n \"viewMetadata\": {},\n \"editMetadata\": {},\n \"devices\": {},\n \"viewFirmwares\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.bytebeam.io/api/v1/roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-bytebeam-api-key"] = '<api-key>'
request["x-bytebeam-tenant"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"permissions\": {\n \"editFirmwares\": true,\n \"viewFiles\": true,\n \"editTenantSettings\": true,\n \"homepage\": \"<string>\",\n \"dashboardPermittedShareRoles\": {},\n \"viewMetadataKeys\": true,\n \"editMetadataKeys\": true,\n \"editDeviceConfigs\": true,\n \"editRoles\": true,\n \"createDashboards\": true,\n \"viewRoles\": true,\n \"tables\": {},\n \"allowCreatingDevices\": true,\n \"allowedActions\": {},\n \"editFiles\": true,\n \"editUsers\": true,\n \"showDeviceManagementTab\": true,\n \"viewActionTypes\": true,\n \"viewDeviceConfigs\": true,\n \"editStreams\": true,\n \"viewStreams\": true,\n \"editActionTypes\": true,\n \"allowMarkActionAsCompleted\": true,\n \"showActionsTab\": true,\n \"viewUsers\": true,\n \"showDashboardsTab\": true,\n \"viewMetadata\": {},\n \"editMetadata\": {},\n \"devices\": {},\n \"viewFirmwares\": true\n }\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.admin
Create role
POST
/
api
/
v1
/
roles
Create role
curl --request POST \
--url https://cloud.bytebeam.io/api/v1/roles \
--header 'Content-Type: application/json' \
--header 'x-bytebeam-api-key: <api-key>' \
--header 'x-bytebeam-tenant: <api-key>' \
--data '
{
"name": "<string>",
"permissions": {
"editFirmwares": true,
"viewFiles": true,
"editTenantSettings": true,
"homepage": "<string>",
"dashboardPermittedShareRoles": {},
"viewMetadataKeys": true,
"editMetadataKeys": true,
"editDeviceConfigs": true,
"editRoles": true,
"createDashboards": true,
"viewRoles": true,
"tables": {},
"allowCreatingDevices": true,
"allowedActions": {},
"editFiles": true,
"editUsers": true,
"showDeviceManagementTab": true,
"viewActionTypes": true,
"viewDeviceConfigs": true,
"editStreams": true,
"viewStreams": true,
"editActionTypes": true,
"allowMarkActionAsCompleted": true,
"showActionsTab": true,
"viewUsers": true,
"showDashboardsTab": true,
"viewMetadata": {},
"editMetadata": {},
"devices": {},
"viewFirmwares": true
}
}
'import requests
url = "https://cloud.bytebeam.io/api/v1/roles"
payload = {
"name": "<string>",
"permissions": {
"editFirmwares": True,
"viewFiles": True,
"editTenantSettings": True,
"homepage": "<string>",
"dashboardPermittedShareRoles": {},
"viewMetadataKeys": True,
"editMetadataKeys": True,
"editDeviceConfigs": True,
"editRoles": True,
"createDashboards": True,
"viewRoles": True,
"tables": {},
"allowCreatingDevices": True,
"allowedActions": {},
"editFiles": True,
"editUsers": True,
"showDeviceManagementTab": True,
"viewActionTypes": True,
"viewDeviceConfigs": True,
"editStreams": True,
"viewStreams": True,
"editActionTypes": True,
"allowMarkActionAsCompleted": True,
"showActionsTab": True,
"viewUsers": True,
"showDashboardsTab": True,
"viewMetadata": {},
"editMetadata": {},
"devices": {},
"viewFirmwares": True
}
}
headers = {
"x-bytebeam-api-key": "<api-key>",
"x-bytebeam-tenant": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-bytebeam-api-key': '<api-key>',
'x-bytebeam-tenant': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
permissions: {
editFirmwares: true,
viewFiles: true,
editTenantSettings: true,
homepage: '<string>',
dashboardPermittedShareRoles: {},
viewMetadataKeys: true,
editMetadataKeys: true,
editDeviceConfigs: true,
editRoles: true,
createDashboards: true,
viewRoles: true,
tables: {},
allowCreatingDevices: true,
allowedActions: {},
editFiles: true,
editUsers: true,
showDeviceManagementTab: true,
viewActionTypes: true,
viewDeviceConfigs: true,
editStreams: true,
viewStreams: true,
editActionTypes: true,
allowMarkActionAsCompleted: true,
showActionsTab: true,
viewUsers: true,
showDashboardsTab: true,
viewMetadata: {},
editMetadata: {},
devices: {},
viewFirmwares: true
}
})
};
fetch('https://cloud.bytebeam.io/api/v1/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://cloud.bytebeam.io/api/v1/roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'permissions' => [
'editFirmwares' => true,
'viewFiles' => true,
'editTenantSettings' => true,
'homepage' => '<string>',
'dashboardPermittedShareRoles' => [
],
'viewMetadataKeys' => true,
'editMetadataKeys' => true,
'editDeviceConfigs' => true,
'editRoles' => true,
'createDashboards' => true,
'viewRoles' => true,
'tables' => [
],
'allowCreatingDevices' => true,
'allowedActions' => [
],
'editFiles' => true,
'editUsers' => true,
'showDeviceManagementTab' => true,
'viewActionTypes' => true,
'viewDeviceConfigs' => true,
'editStreams' => true,
'viewStreams' => true,
'editActionTypes' => true,
'allowMarkActionAsCompleted' => true,
'showActionsTab' => true,
'viewUsers' => true,
'showDashboardsTab' => true,
'viewMetadata' => [
],
'editMetadata' => [
],
'devices' => [
],
'viewFirmwares' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-bytebeam-api-key: <api-key>",
"x-bytebeam-tenant: <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://cloud.bytebeam.io/api/v1/roles"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"permissions\": {\n \"editFirmwares\": true,\n \"viewFiles\": true,\n \"editTenantSettings\": true,\n \"homepage\": \"<string>\",\n \"dashboardPermittedShareRoles\": {},\n \"viewMetadataKeys\": true,\n \"editMetadataKeys\": true,\n \"editDeviceConfigs\": true,\n \"editRoles\": true,\n \"createDashboards\": true,\n \"viewRoles\": true,\n \"tables\": {},\n \"allowCreatingDevices\": true,\n \"allowedActions\": {},\n \"editFiles\": true,\n \"editUsers\": true,\n \"showDeviceManagementTab\": true,\n \"viewActionTypes\": true,\n \"viewDeviceConfigs\": true,\n \"editStreams\": true,\n \"viewStreams\": true,\n \"editActionTypes\": true,\n \"allowMarkActionAsCompleted\": true,\n \"showActionsTab\": true,\n \"viewUsers\": true,\n \"showDashboardsTab\": true,\n \"viewMetadata\": {},\n \"editMetadata\": {},\n \"devices\": {},\n \"viewFirmwares\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-bytebeam-api-key", "<api-key>")
req.Header.Add("x-bytebeam-tenant", "<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.post("https://cloud.bytebeam.io/api/v1/roles")
.header("x-bytebeam-api-key", "<api-key>")
.header("x-bytebeam-tenant", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"permissions\": {\n \"editFirmwares\": true,\n \"viewFiles\": true,\n \"editTenantSettings\": true,\n \"homepage\": \"<string>\",\n \"dashboardPermittedShareRoles\": {},\n \"viewMetadataKeys\": true,\n \"editMetadataKeys\": true,\n \"editDeviceConfigs\": true,\n \"editRoles\": true,\n \"createDashboards\": true,\n \"viewRoles\": true,\n \"tables\": {},\n \"allowCreatingDevices\": true,\n \"allowedActions\": {},\n \"editFiles\": true,\n \"editUsers\": true,\n \"showDeviceManagementTab\": true,\n \"viewActionTypes\": true,\n \"viewDeviceConfigs\": true,\n \"editStreams\": true,\n \"viewStreams\": true,\n \"editActionTypes\": true,\n \"allowMarkActionAsCompleted\": true,\n \"showActionsTab\": true,\n \"viewUsers\": true,\n \"showDashboardsTab\": true,\n \"viewMetadata\": {},\n \"editMetadata\": {},\n \"devices\": {},\n \"viewFirmwares\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.bytebeam.io/api/v1/roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-bytebeam-api-key"] = '<api-key>'
request["x-bytebeam-tenant"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"permissions\": {\n \"editFirmwares\": true,\n \"viewFiles\": true,\n \"editTenantSettings\": true,\n \"homepage\": \"<string>\",\n \"dashboardPermittedShareRoles\": {},\n \"viewMetadataKeys\": true,\n \"editMetadataKeys\": true,\n \"editDeviceConfigs\": true,\n \"editRoles\": true,\n \"createDashboards\": true,\n \"viewRoles\": true,\n \"tables\": {},\n \"allowCreatingDevices\": true,\n \"allowedActions\": {},\n \"editFiles\": true,\n \"editUsers\": true,\n \"showDeviceManagementTab\": true,\n \"viewActionTypes\": true,\n \"viewDeviceConfigs\": true,\n \"editStreams\": true,\n \"viewStreams\": true,\n \"editActionTypes\": true,\n \"allowMarkActionAsCompleted\": true,\n \"showActionsTab\": true,\n \"viewUsers\": true,\n \"showDashboardsTab\": true,\n \"viewMetadata\": {},\n \"editMetadata\": {},\n \"devices\": {},\n \"viewFirmwares\": true\n }\n}"
response = http.request(request)
puts response.read_bodyThis response has no body data.Authorizations
API key required to authenticate requests.
Tenant(Project) name required to identify the project.
Body
application/jsonapplication/transit+msgpackapplication/transit+jsonapplication/edn
Response
default - undefined
⌘I