MicroStrategy REST API API Documentation
Add members and update group information
PATCH {{baseUrl}}/api/usergroups/:id
Update specific 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 specify the type of update operation (add, replace or remove), provide the value to be used in the update operation, and specify the path to the target where the update operation will be performed, in the body parameter of the request.
Body
PARAM
| Key | Datatype | Required | Description |
fields
|
string | Comma separated top-level field whitelist. This allows client to selectively retrieve part of the response model. If specified, extra filtering will be applied, and for top-level object (if root model is an array, each array element), only the listed fields will be kept in the response. e.g. "id,elements" means to keep only the "id" field and the whole "elements" array field, omitting all other fields of top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization token | |
Content-Type
|
string |
RESPONSES
status
Curl
curl -X PATCH 'baseUrl/api/usergroups/:id?fields=<string>' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"operationList":[{"op":"replace","path":"/description","value":"Software Engineers"},{"op":"add","path":"/members","value":["rd_userId"]}]}'
ENDPOINTS