NSX Autonomous Edge REST API

Associated URIs:

API Description API Path

List node users


Returns the list of users configured to log in to the NSX appliance.
GET /api/v1/node/users

Read node user


Returns information about a specified user who is configured to log in to the
NSX appliance. The valid user IDs are: 0, 10000, 10002.
GET /api/v1/node/users/<userid>

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.
PUT /api/v1/node/users/<userid>

List SSH keys from authorized_keys file for node user


Returns a list of all SSH keys from authorized_keys file for node user
GET /api/v1/node/users/<userid>/ssh-keys

Remove SSH public key from authorized_keys file for node user


POST /api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key

Add SSH public key to authorized_keys file for node user


POST /api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key