NSX-T Data Center REST API

Update node user

Updates attributes of an existing NSX appliance user. This method
cannot be used to add a new user. Modifiable attributes include the
username, full name of the user, and password. If you specify a password in
a PUT request, it is not returned in the response. Nor is it returned in a
GET request.
The specified password does not meet the following complexity requirements:
- minimum 12 characters in length
- minimum 1 uppercase character
- minimum 1 lowercase character
- minimum 1 numeric character
- minimum 1 special character
- minimum 5 unique characters
- default password complexity rules as enforced by the Linux PAM module
The valid user IDs are: 0, 10000, 10002.
Note that invoking this API does not update any user-related properties of
existing objects in the system and does not modify the username field in existing
audit log entries.

Request:

Method:
PUT
URI Path(s):
/api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
/api/v1/cluster/<cluster-node-id>/node/users/<userid>
/api/v1/node/users/<userid>
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
NodeUserProperties+

Example Request:

PUT https://<nsx-mgr>/api/v1/node/users/10000 { "full_name": "Jane L. Doe", "username": "admin1" }

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
NodeUserProperties+

Example Response:

{ "full_name": "Jane L. Doe" "userid": 10000, "username": "admin1" }

Required Permissions:

crud

Feature:

system_administration_passwd_mgmt

Additional Errors: