Host Local Account Manager Change Password

Updates the password of a local user account.

Required privileges: System.Anonymous

Request

URI

POST

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

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 9.1.0.0 APIs.

Request Body

ChangePasswordRequestType of type(s) application/json

Required

{
    "user": "string",
    "oldPassword": "string",
    "newPassword": "string"
}

string

user

Required

the user whose password will be changed.

string As password As password

oldPassword

Required

the user's current (old) password.

string As password As password

newPassword

Required

the user's new password.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidArgument: if newPassword has an invalid format.

InvalidLogin: if the user and oldPassword combination is not valid.

Returns InvalidLogin of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"user":"string","oldPassword":"string","newPassword":"string"}' https://{api_host}/sdk/vim25/{release}/HostLocalAccountManager/{moId}/ChangePassword

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Host Local Account Manager Assign User To Group