MicroStrategy REST API API Documentation
Get user group member info
GET {{baseUrl}}/api/usergroups/:id/members
Get member information for a specific user group. 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 use the includeAccess query parameter to specify whether to list the security roles the user group is a member of and the projects the user group is a member of for each security role.You use flatMembers query parameter to specify whether to flat the members to user level.
Body
PARAM
| Key | Datatype | Required | Description |
projectId
|
string | Project ID | |
securityFilter
|
boolean | Specifies whether to return security filter information | |
includeAccess
|
boolean | Specifies whether to return access for members | |
flatMembers
|
boolean | Specifies whether to flatten the members to user level | |
offset
|
number | Starting point within the collection of returned search results. Use to control paging behavior. | |
limit
|
number | Maximum number of items returned for a single search request. Use to control paging behavior. Use -1 for no limit (subject to governing settings). | |
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 i Curl curl -X GET 'baseUrl/api/usergroups/:id/members?projectId=projectId&securityFilter=false&includeAccess=false&flatMembers=false&offset=0&limit=-1&fields=' -H 'X-MSTR-AuthToken: authToken' ENDPOINTS |