Create User / Create Machine User Copy

POST

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

Last modified:2025-09-11 15:07:35

This endpoint creates either a machine account to integrate the ROCKIT Edge Backend API into existing automated workflows or a user account. By calling this endpoint to create a user account, ROCKITPLAY sends an invitation email to the specified address. By confirming the email address the account will be enabled.

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

Body Params application/json

Example

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

Request Code 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

Example

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

🟠400Invalid Param

🟠401Unauthorized

🟠409Item exists

Modified at 2025-09-11 15:07:35

Create User / Create Machine User

Deployments

Create User / Create Machine User Copy

Required Permissions#

Request

Request Code Samples

Responses

Required Permissions