Create User / Create Machine User

POST

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

Last modified:2025-05-07 10:45:15

This endpoint creates either a machine account to integrate the ROCKIT Edge Backend API into existing automated workflows or a user account.

To create a machine account, use the following body schema:

username

label

roles

To create an user account, use the following body schema:

username

title (optional)

firstname

surname

roles

Required Permissions

users.create

See Roles for more details.

Request

Header Params

x-rockit-beauth-token

string

required

ROCKIT Edge backend authentication token (POST /be/v1/auth) or API key (POST /be/v1/apikeys)

Example:

x-rockit-orgname

string

optional

Example:

x-rockit-username

string

optional

Example:

adminPrincipal

x-rockit-api-key

string

optional

Example:

Body Params application/json

username

string

required

Unique and immutable identifier of the user account.

Match pattern:

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

label

string

optional

An explanatory label describing the machine account purpose.

title

string

required

Title of the user. Optional parameter.

string

optional

Email adress of the user.

firstname

string

optional

Firstname of the user.

surname

string

optional

Surname of the user.

roles

array[string]

required

Array of Roles which the machine account should be associated with.

Example

{
  "username": "exampleUser",
  "title": "Dr.",
  "email": "Cheyenne.Smitham54@hotmail.com",
  "firstname": "Roscoe",
  "surname": "Caroline Murray",
  "roles": [
    "Administrators"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://Example-Server.com/be/v1/users' \
--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 '{
    "username": "exampleUser",
    "title": "Dr.",
    "email": "Cheyenne.Smitham54@hotmail.com",
    "firstname": "Roscoe",
    "surname": "Caroline Murray",
    "roles": [
        "Administrators"
    ]
}'

Responses

🟢200Success

application/json

Body

status

string

required

Indicates that the machine account was created successfully.

message

string

required

Confirms the creation of the account (e.g., "machine account created").

apiKey

string

required

Returns the generated API key for the new machine account, which is used for authenticating subsequent requests.

Example

{
  "status": "success",
  "message": "user account created",
  "password": "PO.sNP@g"
}

🟠400Invalid Param

🟠401Unauthorized

🟠409Item exists

delete users

Deployments

Create User / Create Machine User

Required Permissions#

Request

Request samples

Responses

Required Permissions