users.keycloak

Users 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
users	The configuration for Keycloak users
	type	array
	items	User
additionalProperties	False

User

type	object
properties
enabled	Flag to activate the user.
	type	boolean
username	The username of the user.
	type	string
firstName	The first name of the user.
	type	string
lastName	The last name of the user.
	type	string
email	The email of the user.
	type	string
	pattern	^.+@.+$
groups	The group membership of the user. This must be the full path of the groups
	type	array
	items	type	string
credentials	The credential for the user.
	type	array
	items	Credential
attributes	The attribute of the user
	default	authorizedKeys
	Attributes
additionalProperties	False

Credential

type	object
properties
type	The type of the credential.
	type	string
	enum	password
value	The value for the credential.
	type	string
temporary	Flag to indicate if the credential must be changed at first login.
	type	boolean
initial	Indicate that the credential must only be set if none already exist. If set to ‘true’ every Keycloak restart or configuration update will reset the password to this value.
	type	boolean
	default	True
additionalProperties	False

Attributes

type	object
properties
authorizedKeys	The list of the authorized public key.
	type	array
	items	type	string
apiKey	The api-key associated to the user.
	type	string
defaultDashboard	The id of the default dashboard for the user.
	type	string
defaultViewport	The default viewport (none, fullscreen) for the user.
	type	string
	enum	none, fullscreen
phoneNumber	The phone number for the user.
	type	string
additionalProperties	False