Appliance LocalAccounts set
Set local user account properties.
This operation was added in vSphere API 6.7.
User login name
The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.
User configuration
Show optional properties
{
"password": "string",
"roles": [
{}
]
}{
"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
}Password
This property was added in vSphere API 6.7.
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.
Full name of the user
This property was added in vSphere API 6.7.
If missing or null, user will have no fullname.
Email address of the local account
This property was added in vSphere API 6.7.
If missing or null, user will have no email.
User roles
This property was added in vSphere API 6.7.
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.
Flag indicating if the account is enabled
This property was added in vSphere API 6.7.
If missing or null, defaults to True
Flag indicating if the account password expires
This property was added in vSphere API 6.7.
If missing or null, defaults to True.
Date when the account's password will expire
This property was added in vSphere API 6.7.
If missing or null, will be taken from system defaults (see local-accounts/policy).
Flag indicating if the account will be locked after password expiration
This property was added in vSphere API 6.7.
If missing or null, defaults to True.
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, will be taken from system defaults (see local-accounts/policy).
Minimum number of days between password change
This property was added in vSphere API 6.7.
If missing or null, will be taken from system defaults (see local-accounts/policy).
Maximum number of days between password change
This property was added in vSphere API 6.7.
If missing or null, will be taken from system defaults (see local-accounts/policy).
Number of days of warning before password expires
This property was added in vSphere API 6.7.
If missing or null, will be taken from system defaults (see local-accounts/policy).
Success!
If the account is not found
"Vapi Std Errors NotFound Object"Generic error
"Vapi Std Errors Error Object"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.
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.
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.
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"password:"string","roles":["string"]}' https://{api_host}/api/appliance/local-accounts/{username}