Retrieve UserGroup by ID
GET {{baseUrl}}/api/v3/security/userGroups/:uniqueId?fields=<string>&fields=<string>&count=<string>
Returns a single UserGroup corresponding to provided uniqueId
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
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 detnotes whether counts should be returned in the 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":{"dolore2":"\u003cstring\u003e","sit337":"\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":{"cupidatat_9":"\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"}}