Get users to be added to group
GET {{baseUrl}}/api/users?nameBegins=a&fields=id,name
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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
nameBegins | string | Characters that the user name must begin with. | |
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. |
|
| abbreviationBegins | null | | 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 |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token |