Workspace security objects

In the HCL Compass API, the following objects are available for designing and implementing workspace folder security :

  • The Permission object represents a permission setting for a workspace folder.
  • The Permissions object represents a collection of Permission objects. When all Permission objects in a Permissions collection apply to the same object, the collection is also known as an access control list (ACL). For information on the permission kinds, see Permissions Object.
  • The Folder object represents a workspace folder and facilitates permission and traversal operations.
  • Folders object represents a collection of Folder objects.
  • The Workspace object returns information about the workspace items that are visible to the current user, based on the current ACLs.

A folder permission can be assigned, or granted, to a Compass user group. You can create, read, update, and delete folder permissions from workspace folders. The set of permissions specified for a single folder is the access control list (ACL) for the folder. For more information, see PermissionKind constants.