Skip to main content

Permissions

Permissions control what users can do in your organization. Console uses a Group-Based Permission System where users are assigned to groups, and groups define what actions are allowed.

How It Works​

User β†’ assigned to β†’ Groups β†’ contain β†’ Permissions β†’ allow β†’ Actions

Simple Example:

  • User: Alice
  • Group: Content Editors
  • Permissions: Can read and edit content (but not delete)
  • Result: Alice can view and edit content, but cannot delete it

Groups​

Groups are named collections of permissions. Instead of giving permissions directly to users, you assign users to groups.

Why Use Groups?​

Easier Management

Change permissions for many users at once by updating a group

Consistency

All users in a role have the same permissions

Clarity

Group names make it clear what users can do

Scalability

Add new users without configuring permissions each time

Common Group Examples​

Group NamePurposeTypical Actions
AdministratorsFull controlAll actions
ManagersTeam managementRead, create, update users
EditorsContent managementRead, create, update content
ViewersRead-only accessRead only
SupportCustomer supportRead users, update tickets

Creating a Group​

To create a permission group:

  1. Navigate to Groups
  2. Click Create Group
  3. Fill in the details:
    • Name: e.g., "Content Editors"
    • Description: "Can create and edit content but not delete"
  4. Add permissions/roles:
    • Choose what resources this group can access
    • Select which actions are allowed
  5. Click Create

Group Properties​

Each group has:

  • Name: Display name (e.g., "Administrators")
  • Slug: URL-friendly identifier (e.g., "administrators")
  • Description: What this group is for
  • Roles/Permissions: What the group can do
  • Members: Users assigned to this group

Permissions​

Permissions define specific actions that are allowed on resources.

Permission Structure​

Each permission has three parts:

  1. Target: What resource it applies to
  2. Actions: What can be done
  3. Scope: Where it applies (typically company-wide)

Actions​

Console supports these standard actions:

ActionDescriptionExample
ReadView resourcesSee user list
CreateAdd new resourcesInvite new users
UpdateModify existing resourcesEdit user details
DeleteRemove resourcesRemove users
All (*)EverythingFull administrative access

Targets​

Permissions can target different resource types:

  • Users: User management
  • Groups: Permission management
  • Content: Application-specific content
  • Settings: Configuration and preferences
  • Billing: Payment and subscription (if applicable)

Setting Up Permissions​

Step 1: Plan Your Roles​

Before creating groups, plan your organization's roles:

RoleWhat they doPermissions needed
AdminEverythingAll resources, all actions
ManagerManage usersUsers (read, create, update)
EditorCreate contentContent (read, create, update)
ViewerBrowse onlyAll resources (read only)

Step 2: Create Groups​

Create a group for each role:

Group: "Managers"
└── Permission: Manage Users
β”œβ”€β”€ Target: Users
└── Actions: read, create, update

Step 3: Assign Users​

Add users to the appropriate groups:

  1. Go to Users and select a user
  2. Click Edit
  3. In the Groups section, select relevant groups
  4. Click Save

Changes take effect immediately.

Permission Examples​

Example 1: Content Editor​

Create a group for users who manage content:

Group: "Content Editors"

  • Target: Content
  • Actions: read, create, update
  • Result: Can create and edit content, but cannot delete

Example 2: Support Team​

Create a group for customer support:

Group: "Support Team"

  • Permissions:
    • Users (read) - Can view user information
    • Tickets (read, update) - Can view and update support tickets
  • Result: Can help customers but cannot modify user accounts

Example 3: Department Admin​

Create a group for team administrators:

Group: "Department Admins"

  • Permissions:
    • Users (read, create, update) - Can manage users in their department
    • Groups (read) - Can see what groups exist
  • Result: Can manage users but not company-wide settings

Multi-Group Users​

Users can belong to multiple groups and inherit all permissions from all groups.

Example:

User: Alice
β”œβ”€β”€ Group: "Content Editors" β†’ Can edit content
└── Group: "User Managers" β†’ Can manage users

Result: Alice can both edit content AND manage users

This is useful for:

  • Hybrid roles (e.g., Manager who also edits content)
  • Temporary additional access
  • Cross-functional team members

Best Practices​

1. Use Descriptive Names​

❌ Bad:

  • "Group 1"
  • "Admin"
  • "Users"

βœ… Good:

  • "Content Editors"
  • "Department Administrators"
  • "Support Team Members"

2. Follow Least Privilege​

Give users only the permissions they need:

❌ Bad: Everyone is an Administrator

βœ… Good:

  • Most users: Viewers
  • Team leads: Managers
  • Few trusted users: Administrators

3. Create Role-Based Groups​

Organize groups by role, not by person:

❌ Bad:

  • "Alice's Permissions"
  • "Bob's Access"

βœ… Good:

  • "Marketing Editors"
  • "Engineering Managers"

4. Document Group Purposes​

Add clear descriptions to groups:

Example:

  • Name: "Content Moderators"
  • Description: "Can review and approve user-generated content. Cannot delete users or modify billing."

5. Regular Audits​

Review permissions regularly:

  • Monthly: Check who has administrative access
  • Quarterly: Review all groups and their members
  • Annually: Re-evaluate permission structure

Common Scenarios​

Scenario 1: New Employee​

When: Hiring a new content writer

Steps:

  1. Invite user
  2. Assign to "Content Editors" group
  3. They automatically get content editing permissions

Scenario 2: Promotion​

When: Promoting an editor to manager

Steps:

  1. Keep them in "Content Editors" group
  2. Add them to "Team Managers" group
  3. They now have both permissions

Scenario 3: Temporary Access​

When: Giving temporary admin access

Steps:

  1. Add user to "Temporary Admins" group
  2. Set a calendar reminder to remove them
  3. Remove from group when time expires

Scenario 4: Access Denied Error​

When: User says "I can't access X"

Debug:

  1. Check which groups they're in
  2. Review what permissions those groups have
  3. Add them to appropriate group if missing
  4. Or update the group's permissions

Understanding Access Denied​

When a user tries to do something they don't have permission for:

  1. Console shows an "Access Denied" message
  2. The action is blocked
  3. No partial access - either they can do it or they can't

As an admin:

  • Review the user's groups
  • Check group permissions
  • Add necessary permissions or reassign groups

Next Steps​

For Developers

Want to check permissions programmatically? See the Authorization API Guide.