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 (default) complexity requirements:
- minimum 12 characters in length
- minimum 128 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 configured password complexity may vary as per defined Authentication and Password policies,
which shall be available at: [GET]: /api/v1/node/aaa/auth-policy

The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.
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+

NodeUserProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
full_name	Full name for the user	string
group_id	Primary group id for the user	integer	Readonly Minimum: 0 Maximum: 2147483647
home_dir	The absolute path of user home directory	string	Readonly
last_password_change	Number of days since password was last changed	integer	Readonly Minimum: 0 Maximum: 2147483647
login_shell	The absolute path of login shell	string	Readonly
old_password	Old password for the user (required on PUT if password specified)	string
password	Password for the user (optionally specified on PUT, unspecified on GET)	string
password_change_frequency	Number of days password is valid before it must be changed Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.	integer	Minimum: 0 Maximum: 9999 Default: "90"
password_change_warning	Number of days before user receives warning message of password expiration	integer	Minimum: 0 Maximum: 9999 Default: "7"
password_reset_required	Boolean value that states if a password reset is required	boolean
status	User status Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.	string	Readonly Enum: ACTIVE, PASSWORD_EXPIRED, NOT_ACTIVATED
userid	Numeric id for the user	integer	Readonly Minimum: 0 Maximum: 2147483647
username	User login name (must be "root" if userid is 0)	string	Minimum length: 1 Maximum length: 32 Pattern: "^[a-zA-Z][a-zA-Z0-9@-_.\-]*$"

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+

NodeUserProperties (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
full_name	Full name for the user	string
group_id	Primary group id for the user	integer	Readonly Minimum: 0 Maximum: 2147483647
home_dir	The absolute path of user home directory	string	Readonly
last_password_change	Number of days since password was last changed	integer	Readonly Minimum: 0 Maximum: 2147483647
login_shell	The absolute path of login shell	string	Readonly
old_password	Old password for the user (required on PUT if password specified)	string
password	Password for the user (optionally specified on PUT, unspecified on GET)	string
password_change_frequency	Number of days password is valid before it must be changed Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.	integer	Minimum: 0 Maximum: 9999 Default: "90"
password_change_warning	Number of days before user receives warning message of password expiration	integer	Minimum: 0 Maximum: 9999 Default: "7"
password_reset_required	Boolean value that states if a password reset is required	boolean
status	User status Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.	string	Readonly Enum: ACTIVE, PASSWORD_EXPIRED, NOT_ACTIVATED
userid	Numeric id for the user	integer	Readonly Minimum: 0 Maximum: 2147483647
username	User login name (must be "root" if userid is 0)	string	Minimum length: 1 Maximum length: 32 Pattern: "^[a-zA-Z][a-zA-Z0-9@-_.\-]*$"

Example Response:

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

Required Permissions:

crud

Feature:

system_administration_passwd_mgmt

Update node user

Request:

NodeUserProperties (schema)

Example Request:

Successful Response:

NodeUserProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: