MicroStrategy REST API API Documentation
Get users and user groups linked to a security role
GET {{baseUrl}}/api/securityRoles/:id/projects/:projectId/members
Get all users and user groups that are linked to 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 by specifying the security role ID in the path of the request; you obtain the security role ID using GET /securityRoles. You identify the project by specifying the project ID in the path of the request; you obtain the project ID using GET /projects.
Body
PARAM
| Key | Datatype | Required | Description |
access
|
boolean | If you don't need the data in access field, set this field to false or you will get the full data | |
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": "3rd Party Users",
"id": "D09773F94699124B4D75B48F1B358327",
"type": 34,
"abbreviation": "3rd Party Users",
"description": "User group representing all 3rd party users",
"subtype": 8705,
"dateCreated": "2015-06-30T21:54:54.000+0000",
"dateModified": "2021-03-09T15:18:55.000+0000",
"version": "C3043F3C11EB80EA0B7B0080EF856B1B",
"acg": 255,
"owner": {
"name": "Administrator",
"id": "54F3D26011D2896560009A8E67019608"
},
"source": {},
"extType": 0,
"access": {
"projects": [
{
"name": "Consolidated Education Project",
"id": "CE52831411E696C8BD2F0080EFD5AF44",
"securityRoles": []
},
{
"name": "esse magna",
"id": "8C1F88AC91459483A81699AE7C9C2B60",
"securityRoles": []
}
]
}
}
] |
Curl
curl -X GET 'baseUrl/api/securityRoles/:id/projects/:projectId/members?access=true&fields=' -H 'X-MSTR-AuthToken: authToken'
ENDPOINTS