Service: User

Reading and editing users

Provides read/write access to the user Data Objects.

Functions

Result	Name / Params			Comment
GetResult	user.Get			Returns a filtered list of User Objects. Only for the `UI` the `users` will contain the `password` property though.
		filter	string	(Optional) Filter expression which determines the result set.
		select	string[]	(Optional) List of properties that should be contained in the result objects.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
GetResult	user.Get			Returns a filtered list of User Objects as a follow up to a previous Get call. Only for the `UI` the `users` will contain the `password` property though.
		context	string	The context received within the last get result. Mandatory for subsequent get calls with pagination.
		scroll	int	Scrolls through the result set with 'Next' or 'Prev'. Used for pagination. See EnumPaginationScroll.
		offset	int	(Optional) Offset of the first Object in the result set that should be returned. Used for direct pagination.
		limit	int	(Optional) Maximum amount of Objects that should be returned. (Max : 100000)
User	user.GetOne			Returns a single User Object identified by the given id. Only for the `UI` it will contain the `password` property though.
		id	guid	The User's id.
		select	string[]	(Optional) List of properties that should be contained in the result object.
guid	user.Create			Creates the User in the system and returns the id of the User. When the User does not have an id a new one is created. If a User with the same id already exists the new one is not saved and an empty id is returned. Currently only accessible by the `UI`.
guid		object	User	The User to create.
bool	user.Update			Updates a User with data from the provided Object. Currently only accessible by the `UI`.
bool		object	User	User to update
bool	user.Set			Sets specific properties of a User Object. Currently only accessible by the `UI`.
		id	guid	Id of the User to modify.
		props	value{}	List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.
bool	user.Delete			Deletes a User Object. Returns true if successfully deleted or if no such Object existed to begin with. Currently only accessible by the `UI`.
bool		id	guid	Id of the User to delete.
bool	user.BulkModify			Performs a bulk of changes at once. Currently only accessible by the `UI`.
		create	User[]	(Optional) List of User Objects to create.
		update	User[]	(Optional) List of User Objects to update.
		set	ObjectAspect[]	(Optional) List of User Object properties to set.
		delete	guid[]	(Optional) List of User ids to delete.

Notifications

Name / Params			Comment
user.Created			Notifies new User Objects.
	objects	User[]	Newly created User Objects. Only for the `UI` the `users` will contain the `password` property though.
user.Updated			Notifies updated User Objects.
	objects	User[]	Changed User Objects. Only for the `UI` the `users` will contain the `password` property though.
user.Deleted			Notifies deleted User Objects.
	ids	guid[]	Ids of the deleted User Objects.

Objects

User

Property	Type	Description
Id	guid	(Unique, Readonly) The unique id of the user.
ParentId	guid
Type	int	See EnumUserType.
Code	string	(Unique) Short (max 8 characters) user string id
Login <wg 0.6.0	string	(Unique) Login name (max 120 characters) of the user.
Domain <wg 0.6.0	string	Used with LDAP users (max 50 characters).
Password <wg 0.6.0	string	(Not in default set) User password (max 50 characters). Can only be accessed by the `UI`.
SourceLinks ≥wg 0.6.0	SourceLink[]	Sources associated with this user.
ProfileIds	guid[]	Assigned profiles.
Flags	int	See EnumUserFlags.
Info	string	Remarks
PersonId	guid
FirstName	string	(max 200 characters)
LastName	string	(max 50 characters)
ExtRef	string
LastLoginTime	time	(Readonly)
LastLoginStation	int	(Readonly)
EditTime	time	(Readonly, Not in default set)
EditUser	string	(Readonly, Not in default set)

SourceLink ≥wg 0.6.0

Property	Type	Description
Login	string	Login name of the user.
Source	string	Code of the Authentication Extension that handles this user login.

Enums

EnumUserType

Name	Value	Description
User	1
Group	2

EnumUserFlags (Flags)

Name	Value	Description
IsDisabled	0x1	User account is disabled.
IsInfo <wg 0.6.0	0x2	This is just an info entry for an externally authenticated user.
IsAdmin	0x4	This is an admin without rights limitations. The last admin cannot be deleted.

Last modified September 25, 2026