appliance local accounts: config
The
config structure defines the information required for the account. This structure was added in vSphere API 6.7.Representation:
{
"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
}
"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
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| password | secret | Password. This attribute was added in vSphere API 6.7. |
| roles | string[] | User roles. This attribute was added in vSphere API 6.7. 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 | ||
| 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. |
| full_name | string | Full name of the user. This attribute was added in vSphere API 6.7. Optional. If unset, user will have no fullname. |
| string | Email address of the local account. This attribute was added in vSphere API 6.7. Optional. If unset, user will have no email. | |
| enabled | boolean | Flag indicating if the account is enabled. This attribute was added in vSphere API 6.7. Optional. If unset, defaults to True. |
| password_expires | boolean | Flag indicating if the account password expires. This attribute was added in vSphere API 6.7. Optional. If unset, defaults to True. |
| 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, will be taken from system defaults (see local-accounts/policy). |
| 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, defaults to True. |
| 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, will be taken from system defaults (see local-accounts/policy). |
| 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, will be taken from system defaults (see local-accounts/policy). |
| 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, will be taken from system defaults (see local-accounts/policy). |
| 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, will be taken from system defaults (see local-accounts/policy). |