Refresh Review
Refresh information used in a review.
GET https://instance.securid.com/aveksa/command.submit?cmd=refreshReview
note
Only user and account reviews are supported by this API.
Request
Parameters
| refreshReview | |
| format | properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.json - Useful format for parsing into javascript or other languages. See www.json.org for details. |
| The id of the review result. | |
| coverage | true, false Indicates that the coverage should be refreshed. (Default) true |
| clearreassignments | true, false Indicates that reassignements should be cleared. This parameter is only used when coverage=true. (Default) false |
| users | true, false Indicates that user data should be refreshed. (Default) true |
| groups | true, false Indicates that group data should be refreshed. (Default) true |
| roles | true, false Indicates that role data should be refreshed. (Default) true |
| entitlements | true, false Indicates that entitlement data should be refreshed. (Default) true |
| resources | true, false Indicates that resource data should be refreshed. (Default) false |
| accounts | true, false Indicates that account data should be refreshed. (Default) true |
| descriptions | true, false Indicates that the description information used in the review should be refreshed. |
| reviewAnalysis | true, false Indicates that counts displayed in new review ui should be refreshed. (Default) true |
| applications | A list of the applications comma delimited that should be refreshed. This is only used if entitlements=true. If the entitlements=true and this parameter is not provided, all applications will be refreshed. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Response
Parameters
type | Executed command name |
name | The name of the review. |
run-id | The id assigned to the refreshing of the review. Use getRunStatus to check the status of the run after this call. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X GET \
"https://instance.securid.com/aveksa/command.submit?cmd=refreshReview&format=json&id=123" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "refreshReview",
"format": "json",
"id": "62",
"users": "true",
"groups": "true",
"roles": "true",
"entitlements": "true"
}
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": "refreshReview",
"format": "json",
"id": "62",
"users": "true",
"groups": "true",
"roles": "true",
"entitlements": "true"
};
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
- 404 Invalid Review Id
- 412 Missing Parameter
{
"data": {
"type": "refreshReview",
"run-id": "5932",
"name": "UAR-3"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>Could not find a report with the id 410000
Query String=cmd=refreshReview&format=json&id=410000</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter id is required.
Query String=cmd=refreshReview&format=json</body>
</html>