LocalAccounts_Config

LocalAccounts_Config

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

JSON Example

{
    "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

password

Required

Password

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.

string

full_name

Optional

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

string

email

Optional

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

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.

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).

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

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).

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).

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

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).