tridion-sites-extensions-api-docs

Home > @tridion-sites/models > UserGroup

UserGroup class

Represents a data of Group of Users.

Signature:

export declare class UserGroup extends Trustee

Extends: Trustee

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, inheritedSystemPrivileges, scope, systemPrivileges, …trusteeArgs })   Constructs a new instance of the UserGroup class

Properties

Property Modifiers Type Description
_backendModel   BackendGroup  
defaultGroupId   number | undefined Default Group Id. Determines the default Group id for current Group.
getInternalModel   () => BackendGroup  
inheritedSystemPrivileges   SystemPrivilegesDictionary | undefined A dictionary containing “SystemPrivilege” and link “UserGroup” associations.
scope   ReadonlyArray<LinkWithIsEditable> | undefined Access to the UserGroup’s scope (also known as “usage constraints”): the Repositories in which the UserGroup can be used. A collection of Repository objects representing the Repositories in which the UserGroup can be used. An empty collection means that the UserGroup is not scoped to particular Repositories. Changes to the collection are reflected in the state of the UserGroup.
systemPrivileges   ReadonlyArray<SystemPrivilege> | undefined A collection of “SystemPrivilege” assigned for this UserGroup.