Represents a group of user accounts defined by the directory service on the Content Engine server.

Access rights and permissions are assigned to a grantee, which can be a user or a group. Access rights can be assigned to a group regardless of whether the group has any members. Users can be added to the group later. When a user is added to a group, the user automatically gains the access rights assigned to the group to which it belongs. A group can also have subgroups.

Security on objects, such as folders and documents, can pertain to particular groups. These groups, and the users and subgroups that make up the group's membership, are defined and created using tools provided by your directory service product (for example, Windows Active Directory, Novell eDirectory, or Oracle Directory Server). Creating user accounts and the groups to which they belong are administrative tasks (typically performed by a system administrator) that are outside the scope of the Content Engine API.

You cannot create a new Group object, but you can instantiate one that has been persisted in your directory service by:

  • Calling GetInstance or FetchInstance on the Factory.Group class.
  • Retrieving an individual Group object from a GroupSet collection object.

You can call methods on the Group object to retrieve information about the group, such as its name and ID, or to get references to other objects. References to other objects may include the users who are members of the group and the subgroups or parent groups of the group.

Namespace:  FileNet.Api.Security
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface IGroup _
	Implements ISecurityPrincipal, IIndependentObject, IEngineObject, ICloneable
C#
public interface IGroup : ISecurityPrincipal, IIndependentObject, 
	IEngineObject, ICloneable
Visual C++
public interface class IGroup : ISecurityPrincipal, 
	IIndependentObject, IEngineObject, ICloneable
JavaScript
FileNet.Api.Security.IGroup = function();
FileNet.Api.Security.IGroup.createInterface('FileNet.Api.Security.IGroup');

ToggleRemarks

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: SecurityPrincipal

ToggleSee Also