Update user details

Update a user’s details, DEPRECATED[4/28/2025]: use updateUserSelective for better field-level control.

POST /api/user/updateUser

Update user details

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/user/updateUser \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "bypassSaml": false,
  "mfaEnabled": true,
  "name": "John Doe",
  "notificationIntervalsV2": [
    {
      "activityTriggerMap": {},
      "deviceFilterSet": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "diagnosticTriggerMap": {},
      "locationActivityTriggerMap": {},
      "locationDiagnosticTriggerMap": {},
      "locationFilterSet": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "locationOnlyFilterSet": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "minuteOfWeekStart": 123,
      "minuteOfWeekStop": 123
    }
  ],
  "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "smsPhoneNumbers": [
    "<string>"
  ],
  "summaryEmailEnabled": true,
  "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "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

Request object for updating user information and settings.

bypassSaml · boolean | null

Whether SAML bypass is enabled for the user

Example:

false

mfaEnabled · boolean | null

Whether MFA is enabled for the user

Example:

true

name · string | null

Name of the user

Example:

"John Doe"

notificationIntervalsV2 · object[] | null

List of notification intervals (V2) for the user

Show child attributes

permissionGroupUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

smsPhoneNumbers · (string | null)[] | null

List of SMS phone numbers for the user

List of SMS phone numbers for the user

summaryEmailEnabled · boolean | null

Whether summary emails are enabled for the user

Example:

true

userUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating a user.

error · boolean | null

errorMsg · string | null

warningMsg · string | null