LocalAccountsConfig

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


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, will be taken from system defaults (see local-accounts/policy).

optional email string

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

optional enabled boolean

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

optional full_name string

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

optional inactive_after_password_expiration boolean

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

optional max_days_between_password_change integer

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

optional min_days_between_password_change integer

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

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.

required password string

Password

optional password_expires boolean

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

optional password_expires_at string

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

required roles array of string

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.

optional warn_days_before_password_expiration integer

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?