usergroup

User Group search by ID

Changed on

Get the User group object specified by the provided groupId

get/group/{userGroupId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/group/{userGroupId}
  • Auth
    none declared

Path parameters

userGroupIdinteger required

Numeric ID of the User Group to get

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