Host Local Account Manager Assign User To Group

Host Local Account Manager Assign User To Group

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

Assigns a user to a group.

Required privileges: Host.Local.ManageUserGroups

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/AssignUserToGroup
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
AssignUserToGroupRequestType of type(s) application/json
Required 
{
    "user": "string",
    "group": "string"
}
string
user
Required

User ID of the account whose group membership is being assigned.

string
group
Required

Destination group account to which the user is being assigned.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

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

AlreadyExists: if the user is already a member of the target group.

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

On This Page
Host Local Account Manager Operations
POST
Host Local Account Manager Assign User To Group
POST
Host Local Account Manager Change Password
POST
Host Local Account Manager Create Group
POST
Host Local Account Manager Create User
POST
Host Local Account Manager Remove Group
POST
Host Local Account Manager Remove User
POST
Host Local Account Manager Unassign User From Group
POST
Host Local Account Manager Update User