usergroup

UserGroup Edit

Changed on

Edit User Group

put/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

ID of the User Group

Request body application/x-www-form-urlencoded

groupstring required

Name of the User Group

decriptionstring

A description of the User Group

libraryQuotastring

The quota that should be applied (KiB). Provide 0 for no quota

isSystemNotificationinteger

Flag (0, 1), should members of this Group receive system notifications?

isDisplayNotificationinteger

Flag (0, 1), should members of this Group receive Display notifications * for Displays they have permissions to see

isDataSetNotificationinteger

Flag (0, 1), should members of this Group receive DataSet notification emails?

isLayoutNotificationinteger

Flag (0, 1), should members of this Group receive Layout notification emails?

isLibraryNotificationinteger

Flag (0, 1), should members of this Group receive Library notification emails?

isReportNotificationinteger

Flag (0, 1), should members of this Group receive Report notification emails?

isScheduleNotificationinteger

Flag (0, 1), should members of this Group receive Schedule notification emails?

isCustomNotificationinteger

Flag (0, 1), should members of this Group receive Custom notification emails?

isShownForAddUserinteger

Flag (0, 1), should this Group be shown in the Add User onboarding form.

defaultHomePageIdinteger

If this user has been created via the onboarding form, this should be the default home page

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

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

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

  • 8e1275395104Revision changes
    • breaking

      removed the request body

    • breaking

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