Retrieve UserGroups
GET {{baseUrl}}/api/v3/security/userGroups?tql=&fields=<string>&fields=<string>&count=<string>&sorting=<string>
Returns a list of all UserGroups
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
tql | null | TQL query string for filtering response list | |
fields | string | UserGroup subentity fields to include in response (See OPTIONS endpoint for valid values) | |
fields | string | UserGroup subentity fields to include in response (See OPTIONS endpoint for valid values) | |
count | string | Boolean that denotes whether counts should be returned in the resultset | |
sorting | string | Sorting order for resultset |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"description":"\u003cstring\u003e","id":"\u003clong\u003e","name":"\u003cstring\u003e","users":{"count":"\u003cinteger\u003e","count_type":"\u003cstring\u003e","data":[{"customTqlTimeout":"\u003clong\u003e","disabled":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","id":"\u003clong\u003e","jobFunction":"\u003cstring\u003e","jobRole":"\u003cstring\u003e","lastLogin":"\u003cdateTime\u003e","lastName":"\u003cstring\u003e","lastPasswordChange":"\u003cdateTime\u003e","locked":"\u003cboolean\u003e","logoutIntervalMinutes":"\u003cinteger\u003e","owner":"\u003cstring\u003e","ownerRoles":{"auteb":"\u003cstring\u003e"},"password":"\u003cstring\u003e","passwordResetRequired":"\u003cboolean\u003e","pseudonym":"\u003cstring\u003e","systemRole":"\u003cstring\u003e","termsAccepted":"\u003cboolean\u003e","termsAcceptedDate":"\u003cdateTime\u003e","tqlTimeout":"\u003clong\u003e","twoFactorResetRequired":"\u003cboolean\u003e","uiTheme":"\u003cstring\u003e","userName":"\u003cstring\u003e"},{"customTqlTimeout":"\u003clong\u003e","disabled":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","id":"\u003clong\u003e","jobFunction":"\u003cstring\u003e","jobRole":"\u003cstring\u003e","lastLogin":"\u003cdateTime\u003e","lastName":"\u003cstring\u003e","lastPasswordChange":"\u003cdateTime\u003e","locked":"\u003cboolean\u003e","logoutIntervalMinutes":"\u003cinteger\u003e","owner":"\u003cstring\u003e","ownerRoles":{"sit_da":"\u003cstring\u003e","enim0":"\u003cstring\u003e"},"password":"\u003cstring\u003e","passwordResetRequired":"\u003cboolean\u003e","pseudonym":"\u003cstring\u003e","systemRole":"\u003cstring\u003e","termsAccepted":"\u003cboolean\u003e","termsAcceptedDate":"\u003cdateTime\u003e","tqlTimeout":"\u003clong\u003e","twoFactorResetRequired":"\u003cboolean\u003e","uiTheme":"\u003cstring\u003e","userName":"\u003cstring\u003e"}],"mode":"\u003cstring\u003e","next":"\u003cstring\u003e","prev":"\u003cstring\u003e"}},{"description":"\u003cstring\u003e","id":"\u003clong\u003e","name":"\u003cstring\u003e","users":{"count":"\u003cinteger\u003e","count_type":"\u003cstring\u003e","data":[{"customTqlTimeout":"\u003clong\u003e","disabled":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","id":"\u003clong\u003e","jobFunction":"\u003cstring\u003e","jobRole":"\u003cstring\u003e","lastLogin":"\u003cdateTime\u003e","lastName":"\u003cstring\u003e","lastPasswordChange":"\u003cdateTime\u003e","locked":"\u003cboolean\u003e","logoutIntervalMinutes":"\u003cinteger\u003e","owner":"\u003cstring\u003e","ownerRoles":{"irure_46":"\u003cstring\u003e","dolora":"\u003cstring\u003e","quisf2":"\u003cstring\u003e"},"password":"\u003cstring\u003e","passwordResetRequired":"\u003cboolean\u003e","pseudonym":"\u003cstring\u003e","systemRole":"\u003cstring\u003e","termsAccepted":"\u003cboolean\u003e","termsAcceptedDate":"\u003cdateTime\u003e","tqlTimeout":"\u003clong\u003e","twoFactorResetRequired":"\u003cboolean\u003e","uiTheme":"\u003cstring\u003e","userName":"\u003cstring\u003e"},{"customTqlTimeout":"\u003clong\u003e","disabled":"\u003cboolean\u003e","firstName":"\u003cstring\u003e","id":"\u003clong\u003e","jobFunction":"\u003cstring\u003e","jobRole":"\u003cstring\u003e","lastLogin":"\u003cdateTime\u003e","lastName":"\u003cstring\u003e","lastPasswordChange":"\u003cdateTime\u003e","locked":"\u003cboolean\u003e","logoutIntervalMinutes":"\u003cinteger\u003e","owner":"\u003cstring\u003e","ownerRoles":{"et72d":"\u003cstring\u003e","nulla_a1":"\u003cstring\u003e","eiusmod_0_a":"\u003cstring\u003e"},"password":"\u003cstring\u003e","passwordResetRequired":"\u003cboolean\u003e","pseudonym":"\u003cstring\u003e","systemRole":"\u003cstring\u003e","termsAccepted":"\u003cboolean\u003e","termsAcceptedDate":"\u003cdateTime\u003e","tqlTimeout":"\u003clong\u003e","twoFactorResetRequired":"\u003cboolean\u003e","uiTheme":"\u003cstring\u003e","userName":"\u003cstring\u003e"}],"mode":"\u003cstring\u003e","next":"\u003cstring\u003e","prev":"\u003cstring\u003e"}}]