Notify Vault Password Change
Notify the server that a vault password for an endpoint has been changed.
POST https://instance.securid.com/aveksa/command.submit?cmd=notifyVaultPasswordChange
note
Requires a user with System:Manage privilege.
Request
Parameters
| notifyVaultPasswordChange | |
| format | properties - (Default) Returns the response as key=value pairs.json - Returns the response as JSON. |
Headers
Bearer token | |
| Accept | application/json |
| application/xml |
Body
The request body must be an XML document with the root element VaultPasswordChange.
<VaultPasswordChange>
<type>CyberArk-CCP-1.1</type>
<uniqueId>
<safe>SampleSafe</safe>
<folder>Root</folder>
<object>SampleObject</object>
</uniqueId>
</VaultPasswordChange>
The vault type as configured in the system. Example: CyberArk-CCP-1.1 | |||||||
XML child elements that identify the endpoint. For CyberArk CCP:
|
Response
This command returns no output parameters. Use the HTTP status code to determine success.
Examples
Request
- Curl
- Python
- Node.js
curl -K -X POST \
"https://instance.securid.com/aveksa/command.submit?cmd=notifyVaultPasswordChange&format=json" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/xml" \
-d "<VaultPasswordChange>
<type>CyberArk-CCP-1.1</type>
<uniqueId>
<safe>SampleSafe</safe>
<folder>Root</folder>
<object>SampleObject</object>
</uniqueId>
</VaultPasswordChange>"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "notifyVaultPasswordChange",
"format": "json"
}
headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/xml'
}
payload = """<VaultPasswordChange>
<type>CyberArk-CCP-1.1</type>
<uniqueId>
<safe>SampleSafe</safe>
<folder>Root</folder>
<object>SampleObject</object>
</uniqueId>
</VaultPasswordChange>"""
response = requests.post(url, params=params, headers=headers, data=payload)
if response.status_code == 200:
data = response.json()
print(data)
else:
print(f"Request failed with status code {response.status_code}")
const axios = require('axios');
const url = "https://instance.securid.com/aveksa/command.submit";
const params = {
cmd: "notifyVaultPasswordChange",
format: "json"
};
const headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/xml'
};
const payload = `<VaultPasswordChange>
<type>CyberArk-CCP-1.1</type>
<uniqueId>
<safe>SampleSafe</safe>
<folder>Root</folder>
<object>SampleObject</object>
</uniqueId>
</VaultPasswordChange>`;
axios.post(url, payload, { params, headers })
.then(response => {
if (response.status === 200) {
console.log(response.data);
} else {
console.log(`Request failed with status code ${response.status}`);
}
})
.catch(error => {
console.error('Error:', error);
});
Response
- 200
- 400 Invalid XML
- 400 Invalid Structure
- 500 Unknown Vault
- 401 Invalid Token
{
"data": {
"type": "notifyVaultPasswordChange"
}
}
Returned when the request body is missing or is not valid XML.
<html>
<head>
<title>Error</title>
</head>
<body>Invalid XML content in the request body: Premature end of file.
Query String=cmd=notifyVaultPasswordChange&format=json</body>
</html>
Returned when the XML does not contain the required child elements.
<html>
<head>
<title>Error</title>
</head>
<body>Invalid XML content in the request body: Invalid payload, not correct structure
Query String=cmd=notifyVaultPasswordChange&format=json</body>
</html>
Returned when the type value does not match any configured vault.
<html>
<head>
<title>Error</title>
</head>
<body>Vault type is not registered: null
Query String=cmd=notifyVaultPasswordChange&format=json</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'notifyVaultPasswordChange'. Token is invalid or expired</body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.