Werk #14824: Custom extensions: Potentially incompatible change in GUI code

Component Setup
Title Custom extensions: Potentially incompatible change in GUI code
Date Oct 21, 2022
Checkmk Editon Checkmk Raw (CRE)
Checkmk Version 2.2.0i1
Level Trivial Change
Class New Feature
Compatibility Incompatible - Manual interaction might be required

This werk only affects developers of custom extensions to Checkmk.

The variable cmk.gui.config.builtin_role_ids, which specifies IDs for built-in user roles, has been split into two new variables:

  • cmk.gui.config.default_authorized_builtin_role_ids: IDs of built-in user roles which

are by default authorized to use dashlets, sidebar snapins etc., unless explicitly specified differently (at the moment admin, user, guest).

  • cmk.gui.config.default_unauthorized_builtin_role_ids: IDs of built-in user roles which
are by default not authorized to use dashlets, sidebar snapins etc., unless explicitly specified differently.

Note that builtin_role_ids still exists (still containing all built-in role IDs), however, most developer will likely want to use cmk.gui.config.default_authorized_builtin_role_ids in the future to avoid unwanted authorizations of new user roles added to default_unauthorized_builtin_role_ids.

Alternatively, you may explicitly declare the roles you want to permit by default using ["admin", "user", "guest"].

To the list of all Werks