User Webservice

Update user details

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

post/api/user/updateUser

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/user/updateUser
  • 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

bypassSamlboolean nullable

Whether SAML bypass is enabled for the user

mfaEnabledboolean nullable

Whether MFA is enabled for the user

namestring nullable

Name of the user

permissionGroupUuidstring RUUID nullable

base 64 (url-safe) uuid string

restrictToAllowedLoginIpsboolean nullable

When true the user's web console sessions are restricted to the org-wide login IP allowlist.

smsPhoneNumbersstring[] nullable

List of SMS phone numbers for the user

summaryEmailEnabledboolean nullable

Whether summary emails are enabled for the user

userUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "mfaEnabled": true,
  "name": "John Doe",
  "notificationIntervalsV2": [
    {
      "deviceFilterSet": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "locationFilterSet": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "locationOnlyFilterSet": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    }
  ],
  "permissionGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "restrictToAllowedLoginIps": true,
  "summaryEmailEnabled": true,
  "userUuid": "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
warningMsgstring nullable

Changes

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