Skip to main content
POST
Update user details

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

permissionGroupUuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

restrictToAllowedLoginIps
boolean | null

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

Example:

true

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
RUUID

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
Last modified on August 7, 2026