User Webservice

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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/user/createUser
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

accessibleRhombusAppsRhombusAppEnum[] nullable

The set of accessible Rhombus apps

emailstring nullable

The email of the user

namestring nullable

The name of the user

permissionGroupUuidstring RUUID nullable

base 64 (url-safe) uuid string

suppressRhombusKeyWelcomeEmailboolean nullable

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

suppressWelcomeEmailboolean nullable

Suppress the welcome email

Example request

{
  "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
responseStatus'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'

Status of the unregister operation

userUuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.