groups.keycloak

Groups configuration

This file allows to define the static groups.

The validation of the groups can not be done entirely during the aggregation. The module might detect errors due to conflict between email, username, … If this is the case, it will start with the state RUNNING_WITH_ERROR.

It is possible to use substitution ↗️ to hide the value on the configuration.

type	object
properties
groups	The configuration for Keycloak groups
	type	array
	items	Group
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

Group

type	object
properties
attributes	The attributes of the group. This field can contain any attributes wanted. The attribute ‘defaultDashboard’ allow a group to define the first dashboard displayed to an user member of this group. If a user has multiple group the dashboard is chosen using the first one found on the groups sorted alphabetically.
clientRoles	The list roles from the clients for the group
name	The name of the group. Use as the identifier for ‘module.rights’
	type	string
path	The path of the group. This must be the full path of the group with the parent included (For example ‘/parent/child’).
	type	string
realmRoles	The list roles from the realm for the group.
	type	array
	items	type	string
subGroups	The list of the sub groups
	type	array
	items	Group
additionalProperties	False