Host Local Account Manager Remove User

Host Local Account Manager Remove User

Removes a local user account.

As of vSphere API 5.1, this operation will first try to remove all permissions associated with the specified account. The permissions of the user are removed one by one, not atomically, and the operation is not rolled back if the removal of some permission fails.

Required privileges: Host.Local.ManageUserGroups

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/RemoveUser
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostLocalAccountManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
RemoveUserRequestType of type(s) application/json
Required
{
    "userName": "string"
}
string
userName
Required

User ID of the user account being removed.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

SecurityError: if trying to remove the last local user with DCUI access, or if trying to remove the last local user with full administrative privileges, or if the system has encountered an error while trying to remove user's permissions. or if the account cannot be removed due to permission issues.

UserNotFound: if the specified userName does not exist.

Returns UserNotFound of type(s) application/json
This response body class contains all of the following: VimFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "principal": "string",
    "unresolved": false
}
string
principal
Required

Principal value that failed lookup.

boolean
unresolved
Required

Flag to indicate whether or not the lookup was unsuccessful.

A false value indicates that the user does not exist in the directory. A true value indicates that the directory could not be contacted, possibly due to a network error.