Appliance LocalAccounts update

Appliance LocalAccounts update

Update selected fields in local user account properties.

This operation was added in vSphere API 6.7.

Request
URI
PATCH
https://{api_host}/api/appliance/local-accounts/{username}
COPY
Path Parameters
string
username
Required

User login name

The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.

Request Body

User configuration

Appliance LocalAccounts UpdateConfig of type(s) application/json
Required 
{
    "password": "string",
    "old_password": "string",
    "full_name": "string",
    "email": "string",
    "roles": [
        "string"
    ],
    "enabled": false,
    "password_expires": false,
    "password_expires_at": "string",
    "inactive_after_password_expiration": false,
    "days_after_password_expiration": 0,
    "min_days_between_password_change": 0,
    "max_days_between_password_change": 0,
    "warn_days_before_password_expiration": 0
}
string As password As password
password
Optional

Password

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

string As password As password
old_password
Optional

Old password of the user (required in case of the password change, not required if superAdmin user changes the password of the other user)

This property was added in vSphere API 6.7.

If missing or null, user may not have password set.

string
full_name
Optional

Full name of the user

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

string
email
Optional

Email address of the local account

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

array of string
roles
Optional

User roles

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.appliance.roles. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.appliance.roles.

boolean
enabled
Optional

Flag indicating if the account is enabled

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

boolean
password_expires
Optional

Flag indicating if the account password expires

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

string As date-time As date-time
password_expires_at
Optional

Date when the account's password will expire

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

boolean
inactive_after_password_expiration
Optional

Flag indicating if the account will be locked after password expiration

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

integer As int64 As int64
days_after_password_expiration
Optional

Number of days after password expiration before the account will be locked

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

integer As int64 As int64
min_days_between_password_change
Optional

Minimum number of days between password change

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

integer As int64 As int64
max_days_between_password_change
Optional

Maximum number of days between password change

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

integer As int64 As int64
warn_days_before_password_expiration
Optional

Number of days of warning before password expires

This property was added in vSphere API 6.7.

If missing or null, value will not be changed

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

404

If the account is not found

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

Generic error

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Appliance Operations
GET
Appliance LocalAccounts get
PUT
Appliance LocalAccounts set
DELETE
Appliance LocalAccounts delete
PATCH
Appliance LocalAccounts update
GET
Appliance LocalAccounts list
POST
Appliance LocalAccounts create