NSX-T Data Center REST API

Update user information in Avi Load Balancer Controller.

Use this API to update a user's information in Avi Load Balancer Controller.
This API is for VCF deployments only.

Request:

Method:

PUT

URI Path(s):

/policy/api/v1/alb/controller-nodes/user

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

ALBControllerUser+

ALBControllerUser (schema)

Name	Description	Type	Notes
clustering_id	Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX.	string	Readonly
is_service_user	Is Service User Whether this is a service user.	boolean
password	Password Password for the user.	secure_string	Required
password_expires	Password Expires Whether the password expires.	boolean	Default: "True"
role	Role Role for the user.	string
username	Username Username for the user.	string	Required

Example Request:

PUT https://<policy-mgr>/policy/api/v1/alb/controller-nodes/user { "username": "test_user", "password": "NewPass@1234", "clustering_id": "e8abab64-774e-48fa-bd5c-41df7aefdb88" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ALBControllerUser+

ALBControllerUser (schema)

Name	Description	Type	Notes
clustering_id	Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX Unique Id for Avi Load Balancer Controller Cluster used in VCF managed NSX.	string	Readonly
is_service_user	Is Service User Whether this is a service user.	boolean
password	Password Password for the user.	secure_string	Required
password_expires	Password Expires Whether the password expires.	boolean	Default: "True"
role	Role Role for the user.	string
username	Username Username for the user.	string	Required

Example Response:

{ "username": "test_user" }

Required Permissions:

crud

Feature:

policy_avi_lb

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable