Create Organization - ROCKITPLAY API

This endpoint allows you to create a new organization in ROCKIT Edge, along with a default role 'Administrators' and its primary administrator user account. On success, it will return the initial password of the organization's administrator user.

Authentication is required via the x-rockit-admin-token header, which must contain a valid administrator token for ROCKIT 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

x-rockit-admin-token

string

required

ROCKIT Edge administrator token generated by gen-admin-token.sh- https://github.com/DACSLABS/rockitplay/blob/master/edge/gen-admin-token.sh

Example:

Body Params application/json

name

string

required

Unique and immutable identifier of the organization, which is to be created. Typically the name of the organization.

Match pattern:

/^[A-Za-z0-9_]{2,50}$/

label

string

required

Human readable label for the organisation. Typically the name of the organization.

username

string

required

Unique and immutable identifier of the admin user. Typically the name of the admin user.

string

required

Email adress of the user.

title

string

optional

Title of the user. Optional parameter.

firstname

string

required

Firstname of the user.

surname

string

required

Surname of the user.

dxorglnk

string

required

orgPrivPemB64

string

optional

64 bit encoded private key. Optional parameter to create an organization, but mandatory if th org need to be able to start game session.

orgPrivPW

string

optional

PrivateKey Password. Optional parameter to create an organization, but mandatory if th org need to be able to start game session.

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

Responses

🟢200200: success

application/json

Body

status

string

required

Indicating that the organization was created successfully.

message

string

required

A confirmation message such as "organization created" confirming the successful creation.

adminPW

string

required

Returns the initial password for the organization's primary administrator user, which is necessary for the login.

Example

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

🟠400400: invalid-param

🟠401401: unauthorized

🟠409409: item-exists