Create user for organization

Create a user for organization with specified name, email, and role permissions, supporting both client and partner user types with proper validation and audit logging.

POST /api/user/createUser

Create user for organization

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/user/createUser \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

CreateUserWSRequest

accessibleRhombusApps · enum<string>[] | null

The set of accessible Rhombus apps

Available options: PARTNER, CONSOLE, RHOMBUS_KEY, UNKNOWN

email · string | null

The email of the user

name · string | null

The name of the user

permissionGroupUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

rhombusKeySettings · object

Show child attributes

suppressRhombusKeyWelcomeEmail · boolean | null

Suppress the welcome email for the Rhombus Key mobile app if the user is provided access

suppressWelcomeEmail · boolean | null

Suppress the welcome email

Response

200 - application/json

OK

Response object for creating a user.

error · boolean | null

errorMsg · string | null

responseStatus · enum<string>

Status of the unregister operation

Available options: BASIC_AUTH_FAILED, PASSWORD_MISMATCH, SAME_PASSWORD, USER_EXISTS, USER_NOT_FOUND, DEVICE_NOT_FOUND, POLICY_NOT_FOUND, LOCATION_NOT_FOUND, ORG_NOT_FOUND, BAD_INPUT, SUCCESS, PASSWORD_TOO_SHORT

userUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg · string | null