Logo
MicroStrategy REST API API Documentation

Get test user

GET {{baseUrl}}/api/users?abbreviationBegins=testuser&fields=id,name,abbreviation

Get information for a specific set of users. 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 set of users to be returned with query parameters that specify the characters that the user name or abbreviation must begin with. You can use other query parameters to limit the results that are returned by specifying a starting point within the results and the maximum number of results that should be returned.

 

Body PARAM

Key Datatype Required Description 
nameBegins
string Characters that the user name must begin with.
abbreviationBegins
string Characters that the user abbreviation must begin with.
offset
null Starting point within the collection of returned search results. Use to control paging behavior. Default value : 0
limit
null Maximum number of items returned for a single search request. Use to control paging behavior. Use -1 for no limit (subject to governing settings). Default value : -1
id
null List of User ids
fields
string



HEADERS

Key Datatype Required Description 
Curl
curl -X GET 'baseUrl/api/users?abbreviationBegins=testuser&fields=id,name,abbreviation?nameBegins=test&abbreviationBegins=testuser&offset=&limit=&id=&fields=id,name,abbreviation' -H 'X-MSTR-AuthToken: authToken'

ENDPOINTS