Service: Rights

Reading rights

Functions

Result	Name / Params			Comment
RightsPolicyGetResult	rights.Get			Returns a filtered list of RightsPolicy Objects.
		mode	DataMode	(Optional) View of the objects to return: raw or effective. Default is effective.
		include	DataMode	(Optional) Adds the other view to the result; only values that differ are added (under @meta.overlay).
		filter	DataFilter	(Optional) Filter definition which determines the result set.
		sort	DataSortItem[]	(Optional) Sorting definition as a list of properties with order.
		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)
		select	string[]	(Optional) List of properties that should be contained in the result objects.
RightsRule[]	rights.GetRules			Get active rules for a specific client or context.
		session	string	(Optional) Session ID of a connection that defines the context indirectly.
		context	RightsTarget[]	(Optional) Context as list of rights targets.

Notifications

Name / Params			Comment
rights.Created			Notifies about new RightsPolicy Objects.
	objects	RightsPolicy[]	Newly created RightsPolicy Objects.
rights.Deleted			Notifies about deleted RightsPolicy Objects.
	ids	guid[]	IDs of the deleted RightsPolicy Objects.

Objects

RightsPolicy

Property	Type	Description
Id	guid	Unique ID of the Data Object.
Target	RightsTarget	Target definition.
Rule	RightsRule	Rule definition.
Weight	int	Optional weight (0..9).

RightsRule

Property	Type	Description
Item	string	Rule applies to this item type. The available item types depend on the application.
Filter	string	Rule only applies to item instances that match this filter expression.
Aspects	string	Rule only applies to parts of the item, e.g., some properties. The expression depends on the item type.
Actions	string[]	Rule applies to these actions. The available actions depend on the item type.
Deny	bool	True for ‘forbid’, otherwise ‘allow’.

RightsTarget

Property	Type	Description
Type	string	Target type. See RightsTargetType.
Id	string	Target ID, code or ID. See RightsTargetType

RightsTargetType

Name	Value	Description
User	user	User of the application. (code)
Station	station	Station of a networked application. (code)
Extension	extension	Configured AOP Extension. (code)
Profile	profile	Profile that defines a role, for example. (ID)

RightsPolicyGetResult

Property	Type	Description
Objects	RightsPolicy[]	Array of Objects.
Pagination	Pagination	Describes the result set, if not all Objects were returned.

Last modified September 25, 2026