If you're a space or system administrator, use this guide to learn about granting permissions to people for access to content and administrative features.

You set permissions while managing spaces, sub-spaces, and blogs. Most permissions are scoped to the level of the root space (where you set global permissions) or sub-spaces. Sub-spaces inherit permissions from a containing space, but you can augment or revoke inherited permissions at the sub-space level.

Note: You don't manage permissions for social groups in the same way you do for spaces. Permissions changes you make in the admin console have no effect on content permissions for groups. Where a group allows people to view or create content, they have that permission for all content that the group supports.

Your ability to manage permissions in a way that best suits how people use Clearspace is one of the application's most important features. Clearspace uses your permissions settings everywhere — whenever someone does anything with spaces or content. Spaces themselves are designed to support the idea that you'll want to give particular groups of people particular kinds of access to a space's features. A space is a kind of sandbox that you can manage access to with permissions.

For example, a system administrator could give someone permission to read documents across the entire application. Then the system or space administrator could give that person permission to create new documents only in a particular sub-space (maybe one that corresponds to the department they work in). In another example, in a Marketing Department space everyone might have permissions that allow them to view and post content, but only those product managers with the appropriate permissions will be able to create and approve content — such as brochures and pricing information — that can be accessed by the sales organization.

Summary

User Types: Anyone, Registered, User, and Group

A user type represents a level of knowledge or trust about a person. You probably feel you have more knowledge or trust about someone who has registered to use Clearspace than you do about someone who is using the application anonymously. User types provide a convenient, built-in way to manage a person's access to application features.

Clearspace includes two default user types that you can't delete: Anyone and Registered Users. Once a user registers, you can assign them permissions as a User or as part of a Group. This results in four categories of Clearspace users who can receive global permissions.

Note: Revoking a permission for Anyone — that is, putting a red X in the permission box — revokes that permission for registered users also. That's true whether or not you explicitly put a green check mark in the permission box for registered users.

Where Do Guest Users Fit In?

If your Clearspace instance is using the document sharing service, you might have guest users. You can't configure permissions for guest users. Guest users are those who have access to the service, but not to your Clearspace instance itself. If they've been invited by someone using your Clearspace instance, their names will show up in the admin console's user summary, but their accounts aren't included in your permissions work.

Permission Levels: Admin, Moderator, and Space Feature

A permission level represents access to a particular set of Clearspace features. Permission levels fall into two kinds: those for administrators and moderators that capture access to a set of features and those for end users that capture access to individual features.

The following briefly describes each of the permission levels. Also, see Feature and UI Access By Permission Type for tables that shows who has access to what.

System Admin

Essentially, a system admin can do anything they want to. They have full access to every Clearspace feature at every space level. Generally speaking, though, a good best practice is to delegate lower-level administrative and moderation access to other people. For example, a person who uses a particular sub-space regularly is probably a better person to act as that space's administrator, or to moderate content in the space. Delegating frees the system administrator to focus on system issues, rather than on space or content issues.

For a guide to things only a system administrator can do, see the System Administrators' Guide.

Space Admin

A space admin has access to administrative features for the space they've been assigned to administer, along with any sub-spaces beneath it (although their space admin access can be revoked in each of those sub-spaces). A space administrator can create sub-spaces, set content defaults, and set permissions for the space. They can see content that is in a moderator's queue but hasn't been approved yet. They can even designate other space administrators.

You'll find a detailed description of what a space admin can do in Managing Spaces.

User Admin and Group Admin

User and group admins can create and edit user and group accounts. These are global permission levels that only a system administrator can grant. A user admin can create and edit user accounts, while a group admin can create and edit group accounts. Neither of these permission level grants a person the ability to set permissions — only to manage account information.

Note that if your Clearspace instance is using LDAP or some other data source that is not writable, having separate user and group admins might not be necessary.

Managing Users and Groups provides more information about what user and group admin can do.

Content Moderator

Granting moderator permission gives someone two kinds of abilities.

Where you set content moderator permission depends on which content you want moderated. For all, though, you grant content moderator permission in the admin console at Spaces > Permissions > Admins & Moderators.

Note: Access to moderation queues isn't inherited to sub-spaces.

But you'll choose a different scope by selecting the change space link on the Admins & Moderators page.

For Moderation Context Choose This Scope
Documents and discussions in a space or project Sub-space containing the content or project.
Documents and discussions in social groups Root space (moderator for content in all social groups).
Personal blog posts everywhere Root space (moderator for posts to all personal blogs).
Space blog posts in a space or project Sub-space the blog was created in.
Announcements and private messages Root space (moderator for all announcements and private messages).

Note that as a failsafe to ensure that moderated requests always have a place to go, new requests are routed in the following order:

  1. If content would be moderated at the sub-space level but there's no moderator there, it goes to the root space moderator's queue.
  2. If content would be moderated at the root space level but there's no moderator there, it goes to the system administrator's queue.

This applies to new requests only. For example, if a request is in the queue when moderators are removed, the requests will remain in the queue until someone approves or rejects them there. Existing requests won't be routed to the next queue up. If there's only one moderator and that person is deleted from the system, then requests currently in the queue will be orphaned even after a new moderator is assigned to that area. If moderation permissions are merely revoked (or un-granted) for someone, then they'll still have access to the requests currently in the queue but won't be able to approve or reject them.

Keep in mind that in order to have moderators approve and reject content in a moderation queue, moderation will need to be enabled for specific content types in the console at Spaces > Settings > Moderation Settings. For more on these, see Managing Spaces. For a detailed look at what content moderators do, see Moderating Content.

Space Feature

For non-administrative people, you can assign fine-grained access to Clearspace features. Features set a the root space level are inherited by sub-spaces.

Note: Space permissions have no effect on permissions in effect in social groups. You can't set these kinds of permissions for social groups.

How Permission Inheritance Works

Permissions you set in a space are inherited by the sub-spaces inside it unless you revoke or grant permissions in those sub-spaces.

Global Space Permissions. A system administrator sets global permissions — whether for all users, specific users, or groups — by setting permissions in the root space. Those permissions are, by default, inherited in all spaces beneath. That applies to both end user permissions — through which people read and create content, for example — and administrative access — such as space administrators, content moderators, and so on.

Sub-Space Permissions. Sub-spaces inherit the permissions of the space that contains them, but a system or space administrator can grant new permissions or revoke permissions according to what's best for the space, effectively overriding inherited permissions.

Note: Permissions are inherited, but other containment-related features are not. For example, searches in a particular space do not return content in its sub-spaces. Also note that access to moderation queues is not inherited; a moderator approves and rejects content only in the area they're assigned to.

When someone accesses content, Clearspace checks permissions as follows:

  1. The application examines global permissions — the permissions the person has within the entire Clearspace instance.
  2. The application looks at Group permissions for groups the person's user account belongs to.
  3. The application applies content permissions at the following levels:
    • Space — Permissions for all people when they log into the space and access space content. Add these permissions to user or group accounts at the space level.
    • Sub-space — Permissions for people in a sub-space. Clearspace checks the person's sub-space permissions to see if they have been modified from the original space-level permissions. If so, when the user accesses content in that space or related sub-spaces, the sub-space permissions override the space permissions. Otherwise, space permissions are inherited by sub-spaces beneath the space.

The following uses snapshots of the admin console permissions pages to show how permission settings are inherited in a space hierarchy. The space hierarchy illustrated here is Root Space > Second-Level Subspace > Third-Level Subspace.

Permissions hierarchy

Note: Revoking a permission for Anyone — that is, putting a red X in the permission box — revokes that permission for registered users also. That's true whether or not you explicitly put a green check mark in the permission box for registered users.

Granting New Permissions

You grant permissions — that is, give access to particular people or groups — with the Grant New Permission tab. This works in basically the same way whether you're granting administrative access or access to space features. In both cases, you select the permission you want to grant, enter the name for a user or group account receiving the access, then click Grant New Permission. To grant permissions, in the admin console go to Spaces > Permissions, then select the space you want to grant permission for. Click Admin & Moderator or Space Permissions to reach the page that describes permissions already set for the space.

The following shows the Grant New Permission tab for space features.

Grant permissions 

Feature and UI Access By Permission Type

People with certain kinds of permissions have certain access to Clearspace features. These features include those in the admin console and those in the end user interface. This lists user interface features and shows which permission level has access to which feature.

Access to the Admin Console

The admin console is available to system admins, space admins, and user and group admins. In some cases, features available in the console are also available in the Clearspace end user interface. The following table lists the pages of the admin console, indicating who has access to the page: system admin, space/community admin, user admin, or group admin. Page names are linked to related documentation.

Admin Console Section Admin Access
Dashboard  
System  
Management  
System Information System
License Information System
System Properties System
Locale System
Log Viewer System
Audit Log Viewer System
Query Stats System
Sending Usage Statistics System
Document Sharing System
Settings  
Attachments System
Images System
Caches System
Space/Community System
Discussions System
Documents System
Email Server System
Message Templates System
Feeds System
OpenSearch Engines System
Page Compression System
Phrase Substitutions System
Private Messages System
Projects System
Search System
Spell Check System
Themes System
Web Services System
Widgets System
Plugins  
Installed Plugins System
Add Plugin System
Database Migration  
Database Migration System
Real-Time  
Overview System
Connection System
Openfire Admin System
Spaces/Communities  
Management  
Summary System
Space/Community
Document Management System
Space/Community
Discussion Management System
Space/Community
Tag Group Management System
Space/Community
Merge Spaces System
Space/Community
Settings  
Space/Community Settings System
Space/Community
Discussion Settings System
Space/Community
Document Settings System
Space/Community
Moderation Settings

System
Space/Community

Abuse Settings

System
Space/Community

Community Everywhere System
Space/Community
Thread Archive Settings System
Space/Community
Extended Properties System
Space/Community
Filters and Macros System
Space/Community
Gateway Settings System
Interceptors System
Permissions  
Admins & Moderators System
Space/Community
Space/Community Permissions System
Space/Community
Blogs  
Management  
Personal Blogs System
System Blogs System
Comments System
Trackbacks System
Migrate System
Settings  
Blog Settings System
Permissions  
Global Permissions System
People  
Management  
User Summary System
User
Create User

System
User

Group Summary System
Group
Create Group System
Group
User Search

System
User
Group

User Relationships System
User
Group
Settings  
Avatar Settings System
Ban Settings System
Password Reset System
Profile and Homepage

System
User
Group

Registration Settings System
Status Level Settings System
User Data Synchronization Settings System
User
Group
User Relationship Settings System
Reporting  
Reporting


Main System
Space/Community
User
Group
Tags System
Space/Community
User
Group
Discussions System
Space/Community
User
Group
Documents System
Space/Community
User
Group
Blogs System
Space/Community
User
Group
People System
Space/Community
User
Group
Settings  
Third-Party Integration System

Access to End User Features

The following sections describes how Clearspace provides access to end user features based on permission levels. Needless to say, whether a given feature — such as the ability to edit a thread — is available to anyone will depend on whether the feature has been enabled for the space's users. These sections focus on typical defaults and illustrate in particular how access is different for administrators and moderators.

Note: Space permissions aren't in effect in social groups.

Access to End User Discussion Features

The following table lists commands for discussions. It shows which commands are available depending on a person's permission level. Some of these are in the Actions list that's displayed when you're viewing the discussion, while others are visible at the bottom of a reply.

Command Location Description
System Admin
Space Admin
Content Moderator
Creator
Viewer
Edit thread Actions list Edit the original message.
Check
Check
Check
Check
Lock thread Actions list Set the thread so that no one can reply.
Check
Check
Check
Move thread Actions list Move the thread to another space.
Check
Check
Check
Delete thread Actions list Delete the thread from Clearspace
Check
Check
Check
Receive/stop email notifications Actions list Control email notifications for yourself (as the person logged in).
Check
Check
Check
Check
Check
Send as email Actions list Send an email about the thread to other people.
Check
Check
Check
Check
Check
Convert thread to document Actions list Create a new document using the text of the thread.
Check
Check
Check
Check
Check
View as PDF Actions list View the thread as PDF file.
Check
Check
Check
Check
Check
View print preview Actions list View the thread as it will be printed.
Check
Check
Check
Check
Check
Edit Reply body Edit the text of a reply.
Check
Check
Check
Check
Delete Reply body Delete a reply.
Check
Check
Check
Check
Branch Reply body Create a new discussion thread using the reply as the first message.
Check
Check
Check
Check
Abuse (with reporting enabled) Reply body Report an abusive post to administrators.
Check
Check
Check
Check
Check
Reply Reply body Add a reply to the thread.
Check
Check
Check
Check
Check

Access to End User Document Features

The following table lists commands for documents. It shows which commands are available depending on a person's permission level. All of these are in the Actions list that's displayed when you're viewing the document.

Command Location Description
System Admin
Space Admin
Content Moderator
Creator
Viewer
Edit document Actions list Open the document in the editing window.
Check
Check
Check
Check
Check
Manage versions Actions list View the document's version history.
Check
Check
Check
Check
Check
Move document Actions list Move the document to another space.
Check
Check
Check
Manage collaboration Actions list Specify who edits and approves the document, and whether comments are allowed.
Check
Check
Check
Check
Delete document Actions list Delete the document from Clearspace.
Check
Check
Check
Check
Receive/stop email notifications Actions list Control email notifications for yourself (as the person logged in).
Check
Check
Check
Check
Check
Send as email Actions list Send an email about the document to other people.
Check
Check
Check
Check
Check
View as PDF Actions list Open the document as PDF file.
Check
Check
Check
Check
Check
View print preview Actions list View the document as it will be printed.
Check
Check
Check
Check
Check

Access to End User Space Features

A person's access to space-level features is determined by their permissions level. These features are typically available when a person is looking at the space's All Content tab. In addition, a system or space admin has access to the customize link on the Overview tab, through which they can customize the layout of the Overview tab.

Command Location Description
System Admin
Space Admin
Content Moderator
Viewer
Start a discussion Actions list Create a new discussion.
Check
Check
Check
Check
Create a document Actions list Create a new document.
Check
Check
Check
Check
Write a blog post Actions list Create a new post to the space's blog. Any set as an author on the blog can post to it, and only those set as an author can post.
Check
Check
Check
Check
Create an announcement Actions list Create an announcement that will be visible in the space.
Check
Check
Check
Create a poll Actions list Create a poll that will be visible on the All Content page, or (optionally) the space overview.
Check
Check
Check
Check
Create a tag group Actions list Create a tag group to collect tags.
Check
Check
Create a sub-space Actions list Create a space that's inside another space.
Check
Check
Create a project Actions list Create a new project to organize tasks.
Check
Check
Check
Check

Permission Defaults for New Spaces

When you create a new space Clearspace prompts you to select a default access scheme. Each of these -- inherited, open, restricted, and private -- is a kind of security template that's made up of particular permissions settings. After you've created the space, you can edit permissions however you like, of course; the access schemes are really just to get you started quickly. The following illustrates show what you get for each.

Inherited

In the inherited scheme, the newly created sub-space inherits permissions from its immediate parent space. By default, as shown here, the green-tinted permissions are granted, while those without a green tint (but with cleared boxes) are not granted.

Inherited scheme

Open

In the open scheme, access is open for registered users but several of the permissions are explicitly revoked for anonymous users. In particular, these users can see the space, documents, and comments, but they can't contribute by creating content, voting in polls, and so on.

Open scheme

Restricted

The restricted access scheme is designed to exclude anonymous users but provide access for registered users.

Restricted scheme

Private

The private scheme revokes permission for everyone accept the system administrator. This scheme is useful if you want to create a space that's unavailable to everyone, with the idea that you're going to explicitly allow access only to certain users or groups. After you create the space, you can grant permissions to those who'll be using it.

Private scheme

Examples: Setting Global and Space Permissions

The following lists a few common scenarios describing things you might want to do when managing permissions, along with how to make changes in the admin console to support those scenarios.

Deny all permissions to everyone, but grant certain permissions to certain groups

Clear all permission check boxes for the root space, then set permissions in subspaces as needed. Clearing the boxes sets root permissions to their unset state; at the root, that state is "not permitted." In other words, you don't need to first explicitly "revoke" permissions at the root level (with red X marks), then selectively grant them. (You can easily clear all of the boxes in the Anyone or Registered Users rows by clicking the Remove icon at the far right of the row.)

While elsewhere a cleared box means "inherit from the containing space," at the root there's nothing to inherit from. That means that none of your users will be able to use Clearspace (reading or adding content) until you start granting permission by selecting check boxes with check marks. Again, remember that in every space beneath the root, a cleared check box means that permissions are inherited.

In the following summary of the root space permissions, only three actions are allowed: viewing the space, reading documents and reading comments. Unless you grant further permission here or in communities contained by the root, users — registered or anonymous — will be able to do only those three things.

Allow read permissions

The following summary of R&D, a space under the root, shows that permission to view the space, read its documents, and read its comments is granted because it is inherited from the root space. No other actions are allowed.

Allowed inherited permissions

Allow any user to see the content in all communities, but allow only registered users to add or edit content for particular communities

At the root space, in the Anyone row, select the "read"-related permissions (View Space, Read Document, Read Comment) with green check marks. For each of the other actions you want to allow, view the permission summary for the space, then select the check box with a green check mark for Registered Users. (When you grant permission for actions for Anyone users, you don't need to explicitly grant them for Registered Users. Registered Users can do whatever you allow for Anyone users unless you explicitly revoke the permission for Registered Users.)

For example, the following illustration shows the permission summary for R&D, a space contained by the root space. The green tint for the View Space, Read Document and Read Comment actions show that those actions are allowed for all users because their permissions are inherited from a containing space (in this case, the root) where they're explicitly allowed. Cleared check boxes for the other actions indicate that permissions for those actions are also inherited, but the actions aren't allowed because permission for them hasn't been granted. Check boxes with green check marks indicate that permission for those actions is granted for this space and its sub-communities.

Inherited permissions

Hide a space from all but a certain group of users

Set permissions as needed for other communities, then revoke View Space permission for Anyone users for the space you want to hide. Finally, create a user group whose members are the users that will have permission to view the "hidden" space, then use a check mark in View Space to explicitly allow that user group to see the space.

The following shows the permission summary for HR, a space contained by the root space. Note that permission for the View Space action is revoked for Anyone users, but it's allowed for the hr_workers user group. This means that no one who isn't a member of hr_workers will be able to see the space. What's more, members of the hr_workers group will be able to do all of the things that registered users can otherwise do in other communities because hr_workers group members are registered users, too. Those allowed actions include everything shown with a green tint, where permission is inherited from the containing space.

In other words, there's no need to explicitly "turn on" permission for an action unless that action is otherwise not allowed. For example, if you wanted hr_workers members to be able to create polls in the HR space, you'd need to put a check mark in the Create Poll check box.

User group permissions

Deny permission for actions to a particular user

Set permissions as needed for other communities, then revoke permissions for the particular user.

In the following summary of permissions for the HR space, Steve is in the hr_workers user group, but his permission for several actions has been revoked. This summary indicates that he can see the HR space (View Space is explicitly checked for hr_workers), he can read comments and documents and rate documents (the green tint indicates "allowed" permission for those actions is inherited), but he can't performed the red-Xed actions (the X revokes permission).

There's no need to revoke his permission for Create Poll, Create Announcement, and Create Image because he never had it: permission for those actions is inherited as "not allowed" (there's no green tint that indicates the action is explicitly allowed in a containing space). Note that you might want to explicitly revoke the user's permission (even if it's currently unnecessary) to ensure they're revoked in the event that you later allow that action in a containing space.

Revoke user permissions

Setting Personal and System Blog Permissions

Permissions behavior is different between spaces and some blogs. Permissions for blogs are split between blogs that aren't contained by a space, project, or group and those that are, such as system and personal blogs. Here's how it breaks down:

Blog Type Permissions You Can Set Where You Set Permissions in the Console
System and personal blogs Create or read these blogs. Blogs > Permissions > Global Permissions
  Post to these blogs. Spaces (for the containing space) > Permissions > Space Permissions
Space and project blogs Post to these blogs. Spaces (for the containing space) > Permissions > Space Permissions
Group blogs Post to these blogs. Spaces (for the root space) > Permissions > Space Permissions


Note that you can't set "create blog" permission for blogs in spaces, projects, and groups. Instead, whether those contexts have a blog (in other words, whether one is created there) is based on settings someone makes when creating the space, project, or group. Likewise, you can't set "read blog" permission for a space, project, or group -- if there's a blog there, someone with access to that context can read its posts.

Examples: Setting Global Blog Permissions

Here are a few scenarios that illustrate things you might want to do, and how you can set blog permissions to do them. Note that the settings under the Blog tab in the admin console affect top-level (system and personal) blog only. You can manage settings for another kinds of blog by going to that blog's Manage Blog page.

Set permissions to read blogs and create blogs for system and personal blogs

Set global permissions for blogs at the Blogs > Permissions tab in the admin console.

Grant permission for a particular user to post to a particular blog

For a space or project blog, you grant the Create Blog Post permission when settings permissions for the space at Spaces > Permissions > Space Permissions.

For a system or personal blog, go to Blogs > Management > System Blogs and choose System Blogs or Personal Blogs. In the list of blogs, find the one you want to change and click the Edit icon. On the editing page, add the user as an author and click Update Blog.

Admin Console: Blogs > Settings > Global Permissions

Admin Console: Spaces > Permissions > Space Permissions (for the root space)