PUT /api/3/users/{id} – Rapid7 VM API

User

Updates the details of a user. <br>Privileges: Global Administrator

put/api/3/users/{id}

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/users/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

idinteger required

The identifier of the user.

Example:9

assetGroupCountUserEdit circular

emailstring

The email address of the user.

enabledboolean

Whether the user account is enabled. Defaults to true.

idobject

The identifier of the user.

lockedboolean

Whether the user account is locked (exceeded maximum password retry attempts).

loginstring required

The login name of the user.

namestring required

The full name of the user.

passwordstring

The password to use for the user.

passwordResetOnLoginboolean

Whether to require a reset of the user's password upon first login. Defaults to false.

siteCountUserEdit circular

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}