Appliance LocalAccounts Policy Info

Appliance LocalAccounts Policy Info
Appliance LocalAccounts Policy Info

The Appliance LocalAccounts Policy Info schema defines the global password policy.

This schema was added in vSphere API 6.7.

JSON Example
{
    "max_days": 0,
    "min_days": 0,
    "warn_days": 0,
    "prior_password_remember_count": 0,
    "failed_attempt_count_before_account_lockout": 0,
    "length_of_lockout_period_in_seconds": 0,
    "fail_interval_between_attempts": 0,
    "minimum_length": 0,
    "minimum_uppercase_char_count": 0,
    "minimum_lowercase_char_count": 0,
    "minimum_numerics_char_count": 0,
    "minimum_special_char_count": 0,
    "managed_at_fleet": false
}
integer As int64 As int64
max_days
Optional

Maximum number of days a password may be used. If the password is older than this, a password change will be forced.

This property was added in vSphere API 6.7.

If missing or null then the restriction will be ignored. This updates the global settings for the new users as well as the existing users. To update the settings for a particular user, PATCH /api/appliance/local-accounts/{username} API can be used

integer As int64 As int64
min_days
Optional

Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected.

This property was added in vSphere API 6.7.

If missing or null then the restriction will be ignored. This updates the global settings for the new users as well as the existing users. To update the settings for a particular user, PATCH /api/appliance/local-accounts/{username} API can be used

integer As int64 As int64
warn_days
Optional

Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration.

This property was added in vSphere API 6.7.

If missing or null then no warning will be provided. This updates the global settings for the new users as well as the existing users. To update the settings for a particular user, PATCH /api/appliance/local-accounts/{username} API can be used

integer As int64 As int64
prior_password_remember_count
Optional

The number of prior passwords for the user to be remembered by the vCenter appliance in order for the appliance to assess non-repetition.

This property was added in vSphere API 9.1.0.0.

If missing or null then no warning will be provided.

integer As int64 As int64
failed_attempt_count_before_account_lockout
Optional

Threshold Number of consecutive authentication failures for the user during the recent interval before the account is locked out.

This property was added in vSphere API 9.1.0.0.

If missing or null then no warning will be provided

integer As int64 As int64
length_of_lockout_period_in_seconds
Optional

The access will be reenabled after n seconds after the lock out.

This property was added in vSphere API 9.1.0.0.

If missing or null then no warning will be provided

integer As int64 As int64
fail_interval_between_attempts
Optional

The length of the interval during which the consecutive authentication failures must happen for the user account lock out

This property was added in vSphere API 9.1.0.0.

If missing or null then the restriction will be ignored.

integer As int64 As int64
minimum_length
Optional

Minimum number of the characters needed in the password.

This property was added in vSphere API 9.1.0.0.

If missing or null then the restriction will be ignored.

integer As int64 As int64
minimum_uppercase_char_count
Optional

Minimum number of upper case characters needed in the password.

This property was added in vSphere API 9.1.0.0.

If missing or null then the restriction will be ignored.

integer As int64 As int64
minimum_lowercase_char_count
Optional

Minimum number of lower case characters needed in the password.

This property was added in vSphere API 9.1.0.0.

If missing or null then the restriction will be ignored.

integer As int64 As int64
minimum_numerics_char_count
Optional

Minimum number of numeric characters needed in the password.

This property was added in vSphere API 9.1.0.0.

If missing or null then the restriction will be ignored.

integer As int64 As int64
minimum_special_char_count
Optional

Minimum number of special characters needed in the password.

This property was added in vSphere API 9.1.0.0.

If missing or null then the restriction will be ignored.

boolean
managed_at_fleet
Optional

Whether the password policy is managed at fleet or not.

This property was added in vSphere API 9.1.0.0.

If missing or null then the password policy is not fleet managed