REST API - update

appliance local accounts: update

Update selected fields in local user account properties. This operation was added in vSphere API 6.7.

Request:

HTTP request

PATCH https://{server}/rest/appliance/local-accounts/{username}

Path Parameters

Name	Type	Description
Required
username	string	User login name.

Request Body Structure:

{
    "config" : {
        "days_after_password_expiration" : 1,
        "inactive_after_password_expiration" : true,
        "roles" : [
            "obj-103",
            "obj-103"
        ],
        "enabled" : true,
        "warn_days_before_password_expiration" : 1,
        "password" : "secret string",
        "old_password" : "secret string",
        "full_name" : "string",
        "min_days_between_password_change" : 1,
        "password_expires" : true,
        "password_expires_at" : "2015-01-01T22:13:05.651Z",
        "email" : "string",
        "max_days_between_password_change" : 1
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
config	update_config	User configuration.
config.password	secret	Password. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.old_password	secret	Old password of the user (required in case of the password change, not required if superAdmin user changes the password of the other user). This attribute was added in vSphere API 6.7. Optional. If unset, user may not have password set.
config.full_name	string	Full name of the user. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.email	string	Email address of the local account. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.roles	string[]	User roles. This attribute was added in vSphere API 6.7. Optional. 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`.
config.enabled	boolean	Flag indicating if the account is enabled. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.password_expires	boolean	Flag indicating if the account password expires. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.password_expires_at	date_time	Date when the account's password will expire. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.inactive_after_password_expiration	boolean	Flag indicating if the account will be locked after password expiration. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.days_after_password_expiration	long	Number of days after password expiration before the account will be locked. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.min_days_between_password_change	long	Minimum number of days between password change. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.max_days_between_password_change	long	Maximum number of days between password change. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.
config.warn_days_before_password_expiration	long	Number of days of warning before password expires. This attribute was added in vSphere API 6.7. Optional. If unset, value will not be changed.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code	Type	Description
404	not_found	If the account is not found
500	error	Generic error