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
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}.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"userName": "string"
}User ID of the user account being removed.
No Content
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
],
"principal": "string",
"unresolved": false
}Principal value that failed lookup.
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.