User

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

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

CreateUserWSRequest

accessibleRhombusAppsenum<string>[] | nullbody

The set of accessible Rhombus apps

emailstring | nullbody

The email of the user

namestring | nullbody

The name of the user

permissionGroupUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

rhombusKeySettingsobjectbody

Show child attributes

bypassSamlboolean | nullbody

credentialProvisioningRulesobjectbody

Show child attributes

endDateProvisionerobjectbody

Show child attributes

typestringbodyrequired

One of:

Show Static Epoch Seconds Provisioner variant

typestringbody

valueinteger<int64> | nullbody

maxMobileCredsAllowedinteger<int32> | nullbody

startDateProvisionerobjectbody

Show child attributes

typestringbodyrequired

One of:

Show Static Epoch Seconds Provisioner variant

typestringbody

valueinteger<int64> | nullbody

remoteUnlockEnabledboolean | nullbody

rhombusKeyAccessEnabledboolean | nullbody

suppressRhombusKeyWelcomeEmailboolean | nullbody

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

suppressWelcomeEmailboolean | nullbody

Suppress the welcome email

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/user/createUser' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "accessibleRhombusApps": [
      "PARTNER"
    ],
    "email": "<string>",
    "name": "<string>",
    "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusKeySettings": {
      "bypassSaml": true,
      "credentialProvisioningRules": {
        "endDateProvisioner": {
          "type": "<string>",
          "value": 0
        },
        "maxMobileCredsAllowed": 0,
        "startDateProvisioner": {
          "type": "<string>",
          "value": 0
        }
      },
      "remoteUnlockEnabled": true,
      "rhombusKeyAccessEnabled": true
    },
    "suppressRhombusKeyWelcomeEmail": true,
    "suppressWelcomeEmail": true
  }'

import requests

url = "https://api2.rhombussystems.com/api/user/createUser"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "accessibleRhombusApps": [
        "PARTNER"
    ],
    "email": "<string>",
    "name": "<string>",
    "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusKeySettings": {
        "bypassSaml": True,
        "credentialProvisioningRules": {
            "endDateProvisioner": {
                "type": "<string>",
                "value": 0
            },
            "maxMobileCredsAllowed": 0,
            "startDateProvisioner": {
                "type": "<string>",
                "value": 0
            }
        },
        "remoteUnlockEnabled": True,
        "rhombusKeyAccessEnabled": True
    },
    "suppressRhombusKeyWelcomeEmail": True,
    "suppressWelcomeEmail": True
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/user/createUser', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "accessibleRhombusApps": [
      "PARTNER"
    ],
    "email": "<string>",
    "name": "<string>",
    "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusKeySettings": {
      "bypassSaml": true,
      "credentialProvisioningRules": {
        "endDateProvisioner": {
          "type": "<string>",
          "value": 0
        },
        "maxMobileCredsAllowed": 0,
        "startDateProvisioner": {
          "type": "<string>",
          "value": 0
        }
      },
      "remoteUnlockEnabled": true,
      "rhombusKeyAccessEnabled": true
    },
    "suppressRhombusKeyWelcomeEmail": true,
    "suppressWelcomeEmail": true
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "accessibleRhombusApps": [
                "PARTNER"
              ],
              "email": "<string>",
              "name": "<string>",
              "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "rhombusKeySettings": {
                "bypassSaml": true,
                "credentialProvisioningRules": {
                  "endDateProvisioner": {
                    "type": "<string>",
                    "value": 0
                  },
                  "maxMobileCredsAllowed": 0,
                  "startDateProvisioner": {
                    "type": "<string>",
                    "value": 0
                  }
                },
                "remoteUnlockEnabled": true,
                "rhombusKeyAccessEnabled": true
              },
              "suppressRhombusKeyWelcomeEmail": true,
              "suppressWelcomeEmail": true
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/user/createUser"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "responseStatus": "SUCCESS",
  "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

200 OK

application/json · object

Response object for creating a user.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

responseStatusenum<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

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.