MicroStrategy REST API API Documentation
Get information for a security role
GET {{baseUrl}}/api/securityRoles/:id
Get information for a security role with security role Id. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You specify security role ID in the path of the request, then you can obtain the security role information about its base info(such as name, id and type), assigned privileges and assigned
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 |
RESPONSES
status OK
| {
"name": "Test Security Role",
"id": "FCF9DA3FE047F164B47ED6AFCE61F070",
"type": 44,
"description": "Test security description",
"subtype": 11264,
"dateCreated": "2022-03-22T18:27:24.000+0000",
"dateModified": "2022-03-22T18:27:24.000+0000",
"version": "B84C1F2F17470DC77041349060DD5A28",
"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": [
{
"name": "MicroStrategy Tutorial",
"id": "B7CA92F04B9FAE8D941C3E9B7E0CD754",
"members": []
},
{
"name": "Consolidated Education Project",
"id": "CE52831411E696C8BD2F0080EFD5AF44",
"members": []
}
]
} |
Curl
curl -X GET 'baseUrl/api/securityRoles/:id?fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS