This API has a deprecated equivalent from v7.0U1.
Set Local Accounts
Set local user account properties.
Request
URLURL
https://{api_host}/api/appliance/local-accounts/{username}
Path Parameters
Path Parameters
string
username
Required
User login name The parameter must be an identifier for the resource type: com.vmware.appliance.local_accounts.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
{
"password": "string",
"roles": [
"string"
]
}
string
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
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
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
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
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
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
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).
Authentication
This operation uses the following authentication methods.
Errors
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$LocalAccountsConfig = Initialize-LocalAccountsConfig -Password "MyPassword" -Roles "MyRoles"
Invoke-SetUsernameLocalAccounts -Username "MyUsername" -LocalAccountsConfig $LocalAccountsConfig
PowerCLI Client SDK All Parameters Example
$LocalAccountsConfig = Initialize-LocalAccountsConfig -Password "MyPassword" -OldPassword "MyOldPassword" -FullName "MyFullName" -Email "MyEmail" -Roles "MyRoles" -Enabled $false -PasswordExpires $false -PasswordExpiresAt (Get-Date) -InactiveAfterPasswordExpiration $false -DaysAfterPasswordExpiration 0 -MinDaysBetweenPasswordChange 0 -MaxDaysBetweenPasswordChange 0 -WarnDaysBeforePasswordExpiration 0
Invoke-SetUsernameLocalAccounts -Username "MyUsername" -LocalAccountsConfig $LocalAccountsConfig
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"days_after_password_expiration":0,"email":"string","enabled":false,"full_name":"string","inactive_after_password_expiration":false,"max_days_between_password_change":0,"min_days_between_password_change":0,"old_password":"string","password":"string","password_expires":false,"password_expires_at":"string","roles":["string"],"warn_days_before_password_expiration":0}' https://{api_host}/api/appliance/local-accounts/{username}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/appliance/local-accounts/{username}
x-vmw-doc-operation: set
Availability
Added in 7.0U2
On This Page
Local Accounts Operations
patch
delete
