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": [],
"email": "<string>",
"name": "<string>",
"permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"rhombusKeySettings": {
"bypassSaml": true,
"credentialProvisioningRules": {
"maxMobileCredsAllowed": 123
},
"remoteUnlockEnabled": true,
"rhombusKeyAccessEnabled": true
},
"suppressRhombusKeyWelcomeEmail": true,
"suppressWelcomeEmail": true
}
'import requests
url = "https://api2.rhombussystems.com/api/user/createUser"
payload = {
"accessibleRhombusApps": [],
"email": "<string>",
"name": "<string>",
"permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"rhombusKeySettings": {
"bypassSaml": True,
"credentialProvisioningRules": { "maxMobileCredsAllowed": 123 },
"remoteUnlockEnabled": True,
"rhombusKeyAccessEnabled": True
},
"suppressRhombusKeyWelcomeEmail": True,
"suppressWelcomeEmail": True
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
accessibleRhombusApps: [],
email: '<string>',
name: '<string>',
permissionGroupUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
rhombusKeySettings: {
bypassSaml: true,
credentialProvisioningRules: {maxMobileCredsAllowed: 123},
remoteUnlockEnabled: true,
rhombusKeyAccessEnabled: true
},
suppressRhombusKeyWelcomeEmail: true,
suppressWelcomeEmail: true
})
};
fetch('https://api2.rhombussystems.com/api/user/createUser', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/user/createUser")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessibleRhombusApps\": [],\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"permissionGroupUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"rhombusKeySettings\": {\n \"bypassSaml\": true,\n \"credentialProvisioningRules\": {\n \"maxMobileCredsAllowed\": 123\n },\n \"remoteUnlockEnabled\": true,\n \"rhombusKeyAccessEnabled\": true\n },\n \"suppressRhombusKeyWelcomeEmail\": true,\n \"suppressWelcomeEmail\": true\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"responseStatus": "BASIC_AUTH_FAILED",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"warningMsg": "<string>"
}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.
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": [],
"email": "<string>",
"name": "<string>",
"permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"rhombusKeySettings": {
"bypassSaml": true,
"credentialProvisioningRules": {
"maxMobileCredsAllowed": 123
},
"remoteUnlockEnabled": true,
"rhombusKeyAccessEnabled": true
},
"suppressRhombusKeyWelcomeEmail": true,
"suppressWelcomeEmail": true
}
'import requests
url = "https://api2.rhombussystems.com/api/user/createUser"
payload = {
"accessibleRhombusApps": [],
"email": "<string>",
"name": "<string>",
"permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"rhombusKeySettings": {
"bypassSaml": True,
"credentialProvisioningRules": { "maxMobileCredsAllowed": 123 },
"remoteUnlockEnabled": True,
"rhombusKeyAccessEnabled": True
},
"suppressRhombusKeyWelcomeEmail": True,
"suppressWelcomeEmail": True
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
accessibleRhombusApps: [],
email: '<string>',
name: '<string>',
permissionGroupUuid: 'AAAAAAAAAAAAAAAAAAAAAA',
rhombusKeySettings: {
bypassSaml: true,
credentialProvisioningRules: {maxMobileCredsAllowed: 123},
remoteUnlockEnabled: true,
rhombusKeyAccessEnabled: true
},
suppressRhombusKeyWelcomeEmail: true,
suppressWelcomeEmail: true
})
};
fetch('https://api2.rhombussystems.com/api/user/createUser', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/user/createUser")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"accessibleRhombusApps\": [],\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"permissionGroupUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"rhombusKeySettings\": {\n \"bypassSaml\": true,\n \"credentialProvisioningRules\": {\n \"maxMobileCredsAllowed\": 123\n },\n \"remoteUnlockEnabled\": true,\n \"rhombusKeyAccessEnabled\": true\n },\n \"suppressRhombusKeyWelcomeEmail\": true,\n \"suppressWelcomeEmail\": true\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"responseStatus": "BASIC_AUTH_FAILED",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"warningMsg": "<string>"
}Authorizations
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
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.
api-token, api, partner-api-token, partner-api Body
CreateUserWSRequest
The set of accessible Rhombus apps
PARTNER, CONSOLE, RHOMBUS_KEY, UNKNOWN The email of the user
The name of the user
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Show child attributes
Show child attributes
Suppress the welcome email for the Rhombus Key mobile app if the user is provided access
Suppress the welcome email
Response
OK
Response object for creating a user.
Status of the unregister operation
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 base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"