Update Password

Update Password
Update the password for given account

Update the password for given account

Request
URI
PUT
https://{api_host}/suite-api/api/fleet-management/password-management/accounts/{passwordAccountKey}/password
COPY
Path Parameters
string
passwordAccountKey
Required

A key of the password account which needs to be updated

Request Body

The password query param

VcfUpdatePasswordSpec of type(s) application/json
Required

Show optional properties

{
    "currentPassword": "string",
    "newPassword": "string"
}
"{\n  \"userName\" : \"testUser\",\n  \"currentPassword\" : \"currentPassword\",\n  \"newPassword\" : \"password\"\n}"
string
currentPassword
Required

current password value

string
newPassword
Required

password update value

string
userName
Optional

user name of the account

Authentication
This operation uses the following authentication methods.
Responses
200

The password update task id

Returns WorkflowRequest of type(s) application/json 
"{\n  \"requestId\" : \"4881a542-e10c-4033-b161-41622324db01\",\n  \"requestName\" : \"updatepassword\",\n  \"requestReason\" : \"Update Password of testUser user for NSX Manager appliance with IP/FQDN vip-nsx-mgmt.vrack.vsphere.local\",\n  \"requestType\" : \"Update Password\",\n  \"state\" : \"CREATED\",\n  \"errorCause\" : [ ]\n}"
string
category
Required

Categories for VCF workflow requests

Possible values are : INVENTORY, PASSWORD, CERTIFICATE, LCM_MIGRATION, VCF_PASSWORD_MANAGEMENT, VCF_CERTIFICATE_MANAGEMENT, SERVICE_REGISTRY_ROTATION, SOLUTIONS_CATALOG, SALT_RAAS_CONFIGURATION, VIDB_MIGRATION, VCF_IAM,
integer As int64 As int64
duration
Optional

Duration of the request

array of object
errorCause
Optional

List of errors encountered during workflow execution

string
requestId
Optional

Unique identifier of the request

string
requestName
Required
Constraints: minLength: 1

Name of the workflow request

string
requestReason
Optional

Reason for the workflow request

string
requestType
Required
Constraints: minLength: 1

Type of the workflow request (e.g., CREATE_ENVIRONMENT, VC_DATA_COLLECTION)

string
state
Optional

Current state of the workflow request (e.g., CREATED, IN_PROGRESS, COMPLETED, FAILED)


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"currentPassword":"string","newPassword":"string"}' https://{api_host}/suite-api/api/fleet-management/password-management/accounts/{passwordAccountKey}/password
On This Page
Fleet Password Management Operations
POST
Get Vcf Password Accounts
PUT
Update Password