Host Local Account Manager Unassign User From Group

Deprecated as of vSphere API 5.1, local user groups are not supported and group specific methods will throw NotSupported.

Unassigns a user from a group.

Required privileges: Host.Local.ManageUserGroups

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/UnassignUserFromGroup

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

UnassignUserFromGroupRequestType of type(s) application/json

Required

{
    "user": "string",
    "group": "string"
}

string

user

Required

User being unassigned from group.

string

group

Required

Group from which the user is being removed.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

UserNotFound: if the specified user or group does not exist.

NoPermission: if the group is the only group to which the user belongs.

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.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Host Local Account Manager Operations

POST

Host Local Account Manager Assign User To Group