NEnetxms
Users

Update user

Changed on

Update an existing user. Only the fields provided in the request body will be modified. Requires MANAGE_USERS access right.

put/v1/users/{user-id}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/users/{user-id}
  • Auth
    HTTP bearer

Path parameters

user-idinteger required

User ID

Request body

namestring

New login name

descriptionstring

User description

fullNamestring

Full name

systemRightsinteger

System access rights bitmask

uiAccessRulesstring

UI access rules

authMethodinteger

Authentication method

minPasswordLengthinteger

Minimum password length

disabledUntilinteger

Disabled until time (Unix timestamp)

certMappingMethodinteger

Certificate mapping method

certMappingDatastring

Certificate mapping data. For public key mapping, accepts SHA-256 fingerprint of DER encoded SubjectPublicKeyInfo, hex encoded DER public key, or PEM encoded public key or certificate; always stored as fingerprint.

emailstring

Email address

phoneNumberstring

Phone number

attributesobject

Custom attributes. Replaces all existing attributes, except those whose name starts with a dot - those are owned by client applications (UI state, user preferences) and are kept unless the request lists them explicitly. Null as a value removes the attribute.

groupMembershipinteger[]

List of group IDs the user should belong to (replaces current membership)

Response

User updated successfully

idinteger

User ID

guidstring uuid

User GUID

namestring

Login name

descriptionstring

User description

systemRightsinteger

System access rights bitmask

uiAccessRulesstring

UI access rules

attributesobject

Custom attributes

ldapDnstring nullable

LDAP distinguished name

ldapIdstring nullable

LDAP unique ID

createdinteger

Account creation time (Unix timestamp)

fullNamestring

Full name

graceLoginsinteger

Remaining grace logins

twoFAGraceLoginsinteger

Remaining two-factor authentication grace logins

authMethodinteger

Authentication method (0=Local, 1=RADIUS, 2=Certificate, 3=Certificate or Local, 4=Certificate or RADIUS, 5=LDAP)

certMappingMethodinteger

Certificate mapping method

certMappingDatastring nullable

Certificate mapping data (for public key mapping - SHA-256 fingerprint of DER encoded SubjectPublicKeyInfo)

disabledUntilinteger

Disabled until time (Unix timestamp, 0 if not temporarily disabled)

lastPasswordChangeinteger

Last password change time (Unix timestamp)

lastLogininteger

Last login time (Unix timestamp)

minPasswordLengthinteger

Minimum password length (-1 for system default)

authFailuresinteger

Consecutive authentication failure count

emailstring

Email address

phoneNumberstring

Phone number

groupsinteger[]

List of group identifiers this user belongs to

Changes