MicroStrategy REST API API Documentation
Update info for a specific security role
PATCH {{baseUrl}}/api/securityRoles/:id
Update information for a specific security role. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You identify the security role to update by specifying the security role ID in the path of the request; you obtain the security role ID using GET /securityRoles. You provide the information to update the security role in the body parameter of the request.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
Content-Type
|
string |
RESPONSES
status OK
| {
"name": "Test Security Role",
"id": "7046AE9AC9403C1A4587A79559533461",
"type": 44,
"description": "Test security role description.",
"subtype": 11264,
"dateCreated": "2022-03-22T18:35:11.000+0000",
"dateModified": "2022-03-22T18:35:11.000+0000",
"version": "590398DB49498E36662912BA67D205C1",
"acg": 255,
"owner": {
"name": "MSTR User",
"id": "7FC05A65473CE2FD845CE6A1D3F13233"
},
"acl": [
{
"deny": false,
"type": 1,
"rights": 255,
"trusteeId": "7FC05A65473CE2FD845CE6A1D3F13233",
"trusteeName": "MSTR User",
"trusteeType": 34,
"trusteeSubtype": 8704,
"inheritable": false
},
{
"deny": false,
"type": 1,
"rights": 1,
"trusteeId": "294DEDC011D2F1D56000D98E67019608",
"trusteeName": "Public / Guest",
"trusteeType": 34,
"trusteeSubtype": 8705,
"inheritable": false
}
],
"privileges": [
{
"name": "Create application objects",
"id": "1"
}
],
"projects": [
{
Curl curl -X PATCH 'baseUrl/api/securityRoles/:id?fields=' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"operationList":[{"op":"replace","path":"/description","value":"Test security role description."}]}' ENDPOINTS |