LocalAccountsConfig

The LocalAccounts.Config structure defines the information required for the account.


Properties

string as password
password Required

Password


array of string
roles Required

User roles 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.


integer as int64
days_after_password_expiration Optional

Number of days after password expiration before the account will be locked If unset, will be taken from system defaults (see local-accounts/policy).


string
full_name Optional

Full name of the user If unset, user will have no fullname.


boolean
inactive_after_password_expiration Optional

Flag indicating if the account will be locked after password expiration If unset, defaults to True.


integer as int64
max_days_between_password_change Optional

Maximum number of days between password change If unset, will be taken from system defaults (see local-accounts/policy).


integer as int64
min_days_between_password_change Optional

Minimum number of days between password change If unset, will be taken from system defaults (see local-accounts/policy).


string 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) If unset, user may not have password set.


boolean
enabled Optional

Flag indicating if the account is enabled If unset, defaults to True


boolean
password_expires Optional

Flag indicating if the account password expires If unset, defaults to True.


string as date-time
password_expires_at Optional

Date when the account’s password will expire If unset, will be taken from system defaults (see local-accounts/policy).


string
email Optional

Email address of the local account If unset, user will have no email.


integer as int64
warn_days_before_password_expiration Optional

Number of days of warning before password expires If unset, will be taken from system defaults (see local-accounts/policy).

JSON Example

{
    "password": "string",
    "roles": [
        "string"
    ]
}
Feedback

Was this page helpful?