MicroStrategy REST API API Documentation
Get info for all security roles
GET {{baseUrl}}/api/securityRoles
Get information for all security roles. A security role describes the ability to do something, such as create, edit, add, delete, view, manage, save, search, share, export, and so on. A security role has a name, a description, and a privilege. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. The response includes the security role ID, which other endpoints use as a request parameter to specify the security role to perform an action on.
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": "Analyst",
"id": "CCC8F238462EC1D212607BA3D20894FB",
"type": 44,
"description": "Users granted this role has authoring capabilities",
"subtype": 11264,
"dateCreated": "2017-05-09T01:09:06.000+0000",
"dateModified": "2022-03-11T22:07:51.000+0000",
"version": "0F01BBB26148ED6F6A8C7497C21D9FC0",
"acg": 255,
"owner": {
"name": "Administrator",
"id": "54F3D26011D2896560009A8E67019608"
},
"extType": 0
},
{
"name": "Analytics Architect",
"id": "C68F245F416EAEEB200F14A70765AFB6",
"type": 44,
"description": "Users granted this role can create, publish, and optimize a federated data layer as the enterprise's single version of truth. Users can build and maintain schema objects and abstraction layer on top of various, changing enterprise assets.",
"subtype": 11264,
"dateCreated": "2018-08-16T20:34:41.000+0000",
"dateModified": "2022-01-26T20:07:54.000+0000",
"version": "722E6A53CB4B1315649DA8958F41D55E",
"acg": 255,
"owner": {
"name": "Administrator",
"id": "54F3D26011D2896560009A8E67019608"
},
"extType": 0
}
] |
Curl
curl -X GET 'baseUrl/api/securityRoles?fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS