Skip to main content
POST
/
api
/
user
/
createUser
Create user for organization
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 '
{
  "accessibleRhombusApps": [
    "PARTNER"
  ],
  "email": "<string>",
  "name": "<string>",
  "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "rhombusKeySettings": {
    "bypassSaml": true,
    "credentialProvisioningRules": {
      "endDateProvisioner": {
        "type": "<string>",
        "value": 123
      },
      "maxMobileCredsAllowed": 123,
      "startDateProvisioner": {
        "type": "<string>",
        "value": 123
      }
    },
    "remoteUnlockEnabled": true,
    "rhombusKeyAccessEnabled": true
  },
  "suppressRhombusKeyWelcomeEmail": true,
  "suppressWelcomeEmail": true
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "responseStatus": "BASIC_AUTH_FAILED",
  "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

CreateUserWSRequest

accessibleRhombusApps
(enum<string> | null)[] | null

The set of accessible Rhombus apps

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

Status of the user creation response

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