Edit Password V2 Using PATCH | vRealize Suite Lifecycle Manager REST API

Edit Password V2 Using PATCH

This API is used to edit password based on vmid.

Request

URI

PATCH

https://{api_host}//localhost:8080/lcm/locker/api/v2/passwords/{vmid}

COPY

Path Parameters

string

vmid

Required

vmid

Request Body

PasswordRequestResponseDTO of type(s) application/json

Optional

{
    "alias": "Default Password for vCenters",
    "createdOn": 1605791587373,
    "lastUpdatedOn": 1605791587373,
    "password": "PASSWORD****",
    "passwordDescription": "This password is being used for all my vCenters",
    "principal": "string",
    "referenced": false,
    "transactionId": "string",
    "userName": "administrator@vsphere.local",
    "vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
}

string

alias

Optional

Password Alias

integer As int64 As int64

createdOn

Optional

createdOn

integer As int64 As int64

lastUpdatedOn

Optional

lastUpdatedOn

string

password

Optional

Password Value

string

passwordDescription

Optional

Password Description

string

principal

Optional

principal

boolean

referenced

Optional

referenced

string

transactionId

Optional

transactionId

string

userName

Optional

Username associated with password

string

vmid

Optional

vmid

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns PasswordRequestResponseDTO of type(s) application/json

{
    "alias": "Default Password for vCenters",
    "createdOn": 1605791587373,
    "lastUpdatedOn": 1605791587373,
    "password": "PASSWORD****",
    "passwordDescription": "This password is being used for all my vCenters",
    "principal": "string",
    "referenced": false,
    "transactionId": "string",
    "userName": "administrator@vsphere.local",
    "vmid": "6c9fca27-678d-4e79-9a0f-5f690735e67c"
}

string

alias

Optional

Password Alias

integer As int64 As int64

createdOn

Optional

createdOn

integer As int64 As int64

lastUpdatedOn

Optional

lastUpdatedOn

string

password

Optional

Password Value

string

passwordDescription

Optional

Password Description

string

principal

Optional

principal

boolean

referenced

Optional

referenced

string

transactionId

Optional

transactionId

string

userName

Optional

Username associated with password

string

vmid

Optional

vmid

204

No Content

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message

array of string

recommendations

Optional

recommendations

500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message