MicroStrategy REST API API Documentation
Get user group's privileges and its source for a project
GET {{baseUrl}}/api/usergroups/:id/privileges
Get user group's privileges and its source for a project. 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 user group by specifying the usergroup ID in the path of the request; you obtain the usergroup ID using GET /usergroups. You identify the project by specifying the project ID in the request query; you obtain the project ID using GET /projects.
Body
PARAM
| Key | Datatype | Required | Description |
privilege.level
|
string | Project Level Privilege | |
projectId
|
string | Project ID | |
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
| {
"privileges": [
{
"privilege": {
"id": "30",
"name": "Use server cache",
"description": "This is the privilege required to use server cache",
"level": "project"
},
"sources": [
{
"direct": true
}
]
},
{
"privilege": {
"id": "90",
"name": "Create new folder",
Curl curl -X GET 'baseUrl/api/usergroups/:id/privileges?privilege.level=server&projectId=projectId&fields=' -H 'X-MSTR-AuthToken: authToken' ENDPOINTS |