Developer Documentation

LocalAccountsUpdateConfig

The LocalAccounts.UpdateConfig structure defines the fields that might be updated.


Properties

Required Property Name Type Description
optional days_after_password_expiration integer

Number of days after password expiration before the account will be locked If unset, value will not be changed

optional email string

Email address of the local account If unset, value will not be changed

optional enabled boolean

Flag indicating if the account is enabled If unset, value will not be changed

optional full_name string

Full name of the user If unset, value will not be changed

optional inactive_after_password_expiration boolean

Flag indicating if the account will be locked after password expiration If unset, value will not be changed

optional max_days_between_password_change integer

Maximum number of days between password change If unset, value will not be changed

optional min_days_between_password_change integer

Minimum number of days between password change If unset, value will not be changed

optional old_password string

Old password of the user (required in case of the password change, not required if superAdmin user changes the password of the other user) If unset, user may not have password set.

optional password string

Password If unset, value will not be changed

optional password_expires boolean

Flag indicating if the account password expires If unset, value will not be changed

optional password_expires_at string

Date when the account’s password will expire If unset, value will not be changed

optional roles array of string

User roles If unset, value will not be changed When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.roles. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.roles.

optional warn_days_before_password_expiration integer

Number of days of warning before password expires If unset, value will not be changed

Feedback

Was this page helpful?