Logo
MicroStrategy REST API API Documentation

Update info for a specific user

PATCH {{baseUrl}}/api/users/:id

Update specific information for a specific user. 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 by specifying the user ID in the path of the request; you obtain the user ID using GET /users. 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 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
Content-Type
string




RESPONSES

status





Curl
curl -X PATCH 'baseUrl/api/users/:id?fields=sed minim' -H 'X-MSTR-AuthToken: authToken' -H 'Content-Type: application/json' -d '{"operationList":[{"op":"add","path":"/privileges","value":["267","18"]}]}'

ENDPOINTS