Create Organization

POST

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

Last modified:2025-07-07 16:24:35

This endpoint enables the creation of a new organization in the ROCKIT Backend Edge, including a default 'Administrators' role and an associated primary administrator user. Upon successful creation, the response includes the initial password for the administrator user.

Authentication is required via the x-rockit-beauth-token header, which must contain a valid administrator token for the ROCKIT Backend Edge.

Generating a public/private keypair

ssh-keygen -t rsa -b 4096 -m PEM -f .rockitplay.priv.pem
rm .rockitplay.priv.pem.pub (optional)
openssl rsa -in .rockitplay.priv.pem -pubout -outform PEM -out .rockitplay.pub.pem

Request

Header Params

Body Params application/json

Example

{
    "name" : "{{EDGE_ORG_NAME}}",
    "label" : "{{EDGE_ORG_LABEL}}",
    "username" : "{{EDGE_ORG_ADMIN_USERNAME}}",
    "email" : "{{EDGE_ORG_ADMIN_EMAIL}}",
    "firstname" : "{{EDGE_ORG_ADMIN_FIRSTNAME}}",
    "surname" : "{{EDGE_ORG_ADMIN_SURNAME}}",
    "dxorglnk" : "{{EDGE_DXORGLNK}}",
    "orgPrivPemB64" : "{{EDGE_ORG_PRIV_PEM_B64}}",
    "orgPrivPW" : "{{EDGE_ORG_PRIV_PW}}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://Example-Server.com/be/v1/orgs' \
--header 'x-rockit-beauth-token: eyjhvcIhvds;huVODV...' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name" : "ExampleOrg",
    "label" : "Example Organization",
    "username" : "adminUser",
    "email" : "admin@example.org",
    "firstname" : "John",
    "surname" : "Doe",
    "dxorglnk" : "dxorglnk.ExampleOrg.jAhjafhdsaAS....",
    "orgPrivPemB64" : "HhdsjSDsdfJF...",
    "orgPrivPW" : "examplePrivateKeyPassword"
}'

Responses

🟢200200: success

application/json

Body

Example

{
    "status": "success",
    "message": "organization created",
    "adminPW": ":0-)IrG:kLDvr2"
}

🟠400400: invalid-param

🟠401401: unauthorized

🟠409409: item-exists

Modified at 2025-07-07 16:24:35

ROCKIT Edge - Backend API

Delete Organization