ROCKITPLAY API

Create Role

POST

https://Example-Server.com/be/v1/roles

Last modified:2025-05-07 10:42:33

This endpoint creates a role in your ROCKIT Edge Organization.

Required Permissions

roles.create

See Roles for more details.

Request

Header Params

x-rockit-beauth-token

string

optional

ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)
Mutually excluded with x-rockit-api-key.

Example:

x-rockit-orgname

string

optional

Unique and immutable organization identifier obtained from the ROCKIT Edge administrator.
Requires x-rockit-username and x-rockit-api-key.

Example:

x-rockit-username

string

optional

Unique and immutable username which is accociated with the apikey.
Requires x-rockit-orgname and x-rockit-api-key.

Example:

adminPrincipal

x-rockit-api-key

string

optional

Unique and imuutable apikey which is accociated with an machine user.
Mutually excluded with x-rockit-beauth-token. Requires x-rockit-username and x-rockit-orgname.

Example:

Body Params application/json

name

string

required

apps

integer

required

>= 0<= 15

beUsers

integer

required

>= 0<= 15

bundles

integer

required

>= 0<= 15

consumption

integer

required

>= 0<= 2

dependencies

integer

required

>= 0<= 15

deployments

integer

required

>= 0<= 15

keys

integer

required

>= 0<= 15

roles

integer

required

>= 0<= 15

sources

integer

required

>= 0<= 15

subscriptions

integer

required

>= 0<= 15

tasks

integer

required

>= 0<= 31

trainings

integer

required

>= 0<= 6

Example

{
  "name": "exampleName",
  "apps": 1,
  "beUsers": 15,
  "bundles": 6,
  "consumption": 1,
  "dependencies": 12,
  "deployments": 3,
  "keys": 11,
  "roles": 15,
  "sources": 12,
  "subscriptions": 12,
  "tasks": 20,
  "trainings": 2
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://Example-Server.com/be/v1/roles' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'x-rockit-orgname: ExampleOrg' \
--header 'x-rockit-username: adminPrincipal' \
--header 'x-rockit-api-key: {{_adminPrincipal_apiKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "exampleName",
    "apps": 1,
    "beUsers": 15,
    "bundles": 6,
    "consumption": 1,
    "dependencies": 12,
    "deployments": 3,
    "keys": 11,
    "roles": 15,
    "sources": 12,
    "subscriptions": 12,
    "tasks": 20,
    "trainings": 2
}'

Responses

🟢200200: success

application/json

Body

status

string

required

Indicates that the app creation operation was successful.

message

string

required

A confirmation message (e.g., "app created") confirming that the new app has been registered.

Example

{
  "status": "success",
  "message": "role created"
}

🟠400400: missing-param

🟠401401: token-expired

🟠409409: item-exists

List Roles

Patch Role

Create Role

Required Permissions#

Request

Request samples

Responses

Required Permissions