Settings

Owned by An De Moor
Last updated: Feb 03, 2023
1 min read

Introduction

Settings provide values for predefined settings definitions. Settings groups combine settings for a particular service type (e.g. WEBSITE, WORKFLOW_ENGINE, etc) and have a human readable key. Both the Id and Key uniquely identify a settings group. As some keys are in fact numbers, two settings groups can meet the request. In this case, the match with the same key takes precedence. Settings can only be requested in the context of a settings group.

Authorization functions

Following authorization functions are needed for managing settings:

  • VIEW_SYSTEM_SETTINGS: Requesting system settings groups or requesting settings with privilege = SYSTEM

  • VIEW_ADMIN_SETTINGS OR VIEW_SYSTEM_SETTINGS: Requesting non-system settings groups or requesting settings with privilege = ADMIN

  • EDIT_SYSTEM_SETTINGS: Updating settings of system settings groups or updating settings with privilege = SYSTEM

  • EDIT_ADMIN_SETTINGS OR EDIT_SYSTEM_SETTINGS: Updating settings of non-system settings groups or updating settings with privilege = ADMIN

  • ADMIN_ALL_ORGANISATIONS: Requesting / updating setting groups from other organisations