Commit Role
Commit current pending changes to a role.
POST https://instance.securid.com/aveksa/command.submit?cmd=commitRole
Request
Parameters
| commitRole | |
| The ID of the role for which changes will be committed. | |
| format | properties - (Default) Returns the response as key=value pairs.json - Returns the response as JSON. |
| token | Deprecated. Use the Authorization request header instead. |
Headers
Bearer token | |
| Accept | application/json |
| Content-Type | application/json |
Body
Send the proposed role changes as the request body. The body may be empty to commit changes already staged on the server.
Response
Parameters
crId | The change request ID created for the role update. |
crName | The change request name created for the role update. |
status | success or failure |
message | Optional message returned with the status. |
Examples
Request
- Curl
- Python
- Node.js
curl -K -X POST \
"https://instance.securid.com/aveksa/command.submit?cmd=commitRole&format=json&roleId=6764" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"
import requests
url = "https://instance.securid.com/aveksa/command.submit"
params = {
"cmd": "commitRole",
"format": "json",
"roleId": "6764"
}
headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
}
response = requests.post(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: "commitRole",
format: "json",
roleId: "6764"
};
const headers = {
'Authorization': 'Bearer <token>',
'Content-Type': 'application/json'
};
axios.post(url, null, { 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
- 404 Not Found
- 412 Missing Parameter
{
"data": {
"status": "success",
"crId": "1234",
"crName": "Update Role: Test Role 3"
}
}
<html>
<head>
<title>Error</title>
</head>
<body>The token is not valid for the command 'commitRole'. Token is invalid or expired</body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The role with ID <roleId> could not be found.
Query String=cmd=commitRole&format=json&roleId=<roleId></body>
</html>
<html>
<head>
<title>Error</title>
</head>
<body>The parameter roleId is required and should be a number.
Query String=cmd=commitRole&format=json</body>
</html>
Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.
See Also
- Add Group To Role: Add a user group to a role before committing
- Remove Group From Role: Remove a user group from a role before committing