groups.keycloak

Groups configuration

type

object

properties

  • 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

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • groups

The configuration for Keycloak groups

type

array

items

Group

additionalProperties

False

Group

type

object

properties

  • 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

  • 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

  • subGroups

The list of the sub groups

type

array

items

Group

additionalProperties

False