Sign in
usergroup

UserGroup Search

Search User Groups

get/group

Query parameters

userGroupIdinteger

Filter by UserGroup Id

userGroupstring

Filter by UserGroup Name

sortBy'groupId' | 'group' | 'description' | 'libraryQuota' | 'isSystemNotification' | 'isDisplayNotification' | 'isDataSetNotification' | 'isLayoutNotification' | 'isLibraryNotification' | 'isReportNotification' | 'isScheduleNotification' | 'isCustomNotification' | 'isShownForAddUser'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

groupIdinteger

The Group ID

groupstring

The group name

isUserSpecificinteger

A flag indicating whether this is a user specific group or not

isEveryoneinteger

A flag indicating the special everyone group

descriptionstring

Description of this User Group

libraryQuotainteger

This users library quota in bytes. 0 = unlimited

isSystemNotificationinteger

Does this Group receive system notifications.

isDisplayNotificationinteger

Does this Group receive display notifications.

isDataSetNotificationinteger

Does this Group receive DataSet notifications.

isLayoutNotificationinteger

Does this Group receive Layout notifications.

isLibraryNotificationinteger

Does this Group receive Library notifications.

isReportNotificationinteger

Does this Group receive Report notifications.

isScheduleNotificationinteger

Does this Group receive Schedule notifications.

isCustomNotificationinteger

Does this Group receive Custom notifications.

isShownForAddUserinteger

Is this Group shown in the list of choices when onboarding a new user

defaultHomepageIdstring

Default Home page for new users

featuresstring[]

Features this User Group has direct access to

Changes

Changed in 3 of the 52 revisions of this API.13

  • fe497e811c7f2See the full diff
    • ○

      added the new optional query request parameter sortBy

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortDir

      new-optional-request-parameter

  • 41c04de98ec51See the full diff
    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8e12753951041See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog