Deactivate a user account

Deactivates the account for this user. Deactivating an account is
permanent, unlike an account that is temporarily locked because of
too many password failures. A deactivated account has to be explicitly
activated. When an account is successfully deactivated, the "status"
field in the response is "NOT_ACTIVATED".
This API is not supported for userid 0 and userid 10000.

Request:

Method:

POST

URI Path(s):

/api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=deactivate
/api/v1/node/users/<userid>?action=deactivate

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

POST https://<nsx-mgr>/api/v1/node/users/10004?action=deactivate

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
last_password_change	Number of days since password was last changed	integer	Readonly Minimum: 0 Maximum: 2147483647
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
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": "Cloud Auditor", "last_password_change": 0, "password_change_frequency": 0, "status": "NOT_ACTIVATED", "userid": 10004, "username": "cloud_audit" }

Deactivate a user account

Request:

Example Request:

Successful Response:

NodeUserProperties (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: