MicroStrategy REST API API Documentation
Create a user group
POST {{baseUrl}}/api/usergroups
Create a new user group. The response includes the usergroup ID, which other endpoints use as a request parameter to specify the user group to perform an action on. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. You provide the information to create the user group in the body parameter of the request - including the name and description of the user group, the IDs of parent user groups, and the IDs of child users or user groups.
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 POST 'baseUrl/api/usergroups?fields=<string>' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"name":"TestUserGroup","description":"A test user group"}'
ENDPOINTS