NSX-T Data Center REST API

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+

Example Response:

{ "full_name": "Cloud Auditor", "last_password_change": 0, "password_change_frequency": 0, "status": "NOT_ACTIVATED", "userid": 10004, "username": "cloud_audit" }

Required Permissions:

crud

Feature:

system_administration

Additional Errors: