NEnetxms
Users

Get user details

Changed on

Retrieve details of a specific user by ID. Requires MANAGE_USERS access right.

get/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

Response

User retrieved 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