Update Local Accounts
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Update selected fields in local user account properties.
Request
URLURL
https://{api_host}/rest/appliance/local-accounts/{username}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains LocalAccountsUpdateRequestBody
of type application/json
(required)
{
"config": {
"days_after_password_expiration": 0,
"email": "string",
"enabled": false,
"full_name": "string",
"inactive_after_password_expiration": false,
"max_days_between_password_change": 0,
"min_days_between_password_change": 0,
"old_password": "string",
"password": "string",
"password_expires": false,
"password_expires_at": "string",
"roles": [
"string"
],
"warn_days_before_password_expiration": 0
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | config | LocalAccountsUpdateConfig |
User configuration |
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"config":{"days_after_password_expiration":0,"email":"string","enabled":false,"full_name":"string","inactive_after_password_expiration":false,"max_days_between_password_change":0,"min_days_between_password_change":0,"old_password":"string","password":"string","password_expires":false,"password_expires_at":"string","roles":["string"],"warn_days_before_password_expiration":0}}' https://{api_host}/rest/appliance/local-accounts/{username}
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : If the account is not found | com.vmware.vapi.std.errors.error : Generic error |
| default | ErrorRest | Not available |
On This Page
Local Accounts Operations
patch
delete
