Users

Since users are not currently stored in the database, the REST interface for them is not as full-fledged as that of nodes, etc.

You cannot use hibernate criteria for filtering. You may need to touch the ${OPENNMS_HOME}/etc/users.xml file on the filesystem for any addition or modification actions to take effect (see NMS-6469 for details).

GETs (Reading Data)

Parameter Description

/users

Get a list of users.

/users/{username}

Get a specific user, by username.

POSTs (Adding Data)

Parameter Description

/users

Add a user. If supplying a password it is assumed to be hashed or encrypted already. To indicate that the supplied password uses the salted encryption algorithm rather than the older MD5-based algorithm, you need to pass an element named passwordSalt with text true after the password element (or key/value pairs if using JSON). Note: You may add the query parameter hashPassword=true to tell OpenNMS you are passing an unencrypted password; it will hash and salt the password when it is saved.

PUTs (Modifying Data)

Parameter Description

/users/{username}

Update an existing user’s full-name, user-comments, password, passwordSalt, and duty-schedule values. Note: If you are setting the password, you may also add the query parameter hashPassword=true to tell OpenNMS you are passing an unencrypted password so it will hash and salt the password when it is saved.

/users/{username}/roles/{rolename}

Add a security role to the user.

DELETEs (Removing Data)

Resource Description

/users/{username}

Delete a user.

/users/{username}/roles/{rolename}

Remove a security role from the user.