Get info for all user groups
GET {{baseUrl}}/api/usergroups
Get information for a specific set of user groups or all user groups. You can refine the set of user groups that are returned with a query parameter that specifies the characters that the user group name must begin with; if you omit the nameBegins query parameter, all user groups are returned. You can limit the results that are returned with two query parameters. The offset parameter specifies the location in the list of users groups to begin returning results and the limit parameter specifies the maximum number of matching user groups that can be returned; if you set the limit parameter to -1, all results are returned (subject to Governing settings). The total count of results returned is included in the response header as x-mstr-total-count
. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header.
Body
PARAM
| Key | Datatype | Required | Description |
nameBegins
|
null | Characters that the name must begin with | |
offset
|
number | Starting point within the collection of returned search results. Used to control paging behavior. | |
limit
|
number | Maximum number of items returned for a single search request. Used to control paging behavior. Use -1 for no limit (subject to Governing settings). | |
fields
|
null | 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 |
RESPONSES
ENDPOINTS