Process Rule
Process a rule defined in the system.
GET https://instance.securid.com/aveksa/command.submit?cmd=processRule
Request
Parameters
| processRule | |
| format | properties - (Default) Returns the response as key=value pairs.json - Returns the response as JSON. |
| rule | The name of a specific rule to process. If omitted, all active rules in the system are evaluated. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
type | Executed command name |
run-id | The id assigned to the rule processing run. |
run-source-xx | The names of the rules processed as part of this run, where xx is the run id. When multiple rules ran, their names appear as a semicolon-delimited list in a single key. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=processRule&format=json&rule=Cannot%20Request%20Additional%20Tokens" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "processRule",
"format": "json",
"rule": "Cannot Request Additional Tokens"
}
headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
}
response = requests.get(url, params=params, headers=headers)
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: "processRule",
format: "json",
rule: "Cannot Request Additional Tokens"
};
const headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
};
axios.get(url, { 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
- 401 Invalid Token
- 403 Unauthorized
- 404 Rule Not Found
{
"data": {
"type": "processRule",
"run-id": "9978",
"run-source-9978": "Cannot Request Additional Tokens"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'processRule'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>Unauthorized request for processRule from client address /<client-ip></body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The rule Does Not Exist could not be found or it is not active
Query String=cmd=processRule&format=json&rule=Does%20Not%20Exist</body>
</html>
See Also
- Find Change Requests: Query change requests created by rule processing
- Find Change Request Items: Query individual action items within a change request
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.