POST
/
api
/
v1
/
roles
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
  }
}'

Authorizations

x-bytebeam-api-key
string
header
required

API key required to authenticate requests.

x-bytebeam-tenant
string
header
required

Tenant(Project) name required to identify the project.

Body

name
string
required
permissions
object
required