Skip to main content

Getting Started with RBAC

This guide will help you set up and start using Role-Based Access Control in your Workspace Platform workspace. We'll walk through the basics step by step.

Before You Begin​

To manage roles and permissions, you need:

  • Workspace Admin or Manager role
  • Access to your Workspace Platform workspace
  • Understanding of your team structure and access needs
info

Don't have admin access? Contact your workspace administrator to request the necessary permissions or to have them set up RBAC for your team.

Step 1: Access RBAC Settings​

  1. Open Your Workspace

    • Log into Workspace Platform
    • Select your workspace from the workspace switcher

  2. Navigate to Settings

    • Click on your workspace name in the top navigation bar
    • Select "Settings" from the dropdown menu

  3. Find RBAC Controls

    • In the settings sidebar, look for "Roles & Permissions"
    • You'll see tabs for "Roles", "Permissions", and "User Assignments"

Step 2: Review Default Roles​

Workspace Platform comes with pre-configured roles to get you started quickly:

Workspace Level Roles​

  • 🔧 Workspace Admin: Complete control over the workspace
  • 👥 Workspace Manager: Manage settings and members
  • 👀 Workspace Viewer: Read-only access to workspace

Project Level Roles​

  • 🚀 Project Admin: Full control over specific projects
  • 💻 Project Developer: Create and modify project resources
  • 📖 Project Viewer: Read-only access to projects

Team Level Roles​

  • 👑 Team Lead: Manage team members and settings
  • 🤝 Team Member: Basic team participation access
tip

Start with these default roles! They cover most common use cases. You can always create custom roles later as your needs become more specific.

Step 3: Assign Your First Roles​

Let's assign roles to team members:

For Individual Users​

  1. Go to User Assignments

    • Click the "User Assignments" tab
    • You'll see a list of all users in your workspace

  2. Select a User

    • Find the person you want to assign roles to
    • Click "Manage Roles" next to their name

  3. Choose Appropriate Roles

    • Check the boxes for roles that match their job function
    • Example: For a new developer, assign "Project Developer" + "Team Member"
    • Set expiration dates if the access is temporary

  4. Apply Changes

    • Click "Update User Roles"
    • The user immediately gains the new permissions

For Multiple Users (Bulk Assignment)​

  1. Select Multiple Users

    • Use checkboxes to select several users
    • Click "Bulk Actions"

  2. Choose Action

    • Select "Assign Roles"
    • Choose the roles to assign to all selected users

  3. Apply to All

    • Review your selections
    • Click "Apply to Selected Users"

Step 4: Set Up Team-Based Access​

Teams make permission management much easier:

  1. Create or Select a Team

    • Go to Teams in your workspace
    • Either create a new team or select an existing one

  2. Assign Team Roles

    • In the team settings, go to the "Members" tab
    • Set roles for each team member using "Change Role"
    • Common pattern: Team Lead + multiple Team Members

  3. Configure Team Permissions

    • Team members automatically inherit team-level permissions
    • This means less individual role management

Step 5: Test Your Setup​

Before rolling out to your entire team:

  1. Test with a Safe User

    • Ask a team member to test their new permissions
    • Have them try to access resources they should and shouldn't be able to reach

  2. Check Common Actions

    • Can they create what they need to create?
    • Are they blocked from sensitive operations?
    • Can they see the right projects and teams?

  3. Verify Inheritance

    • Ensure team permissions are working correctly
    • Check that workspace permissions apply to projects as expected

Step 6: Create Your First Custom Role (Optional)​

Once you're comfortable, you might need custom roles:

  1. Navigate to Roles Tab

    • Go back to "Roles & Permissions" → "Roles"
    • Click "Create Role"

  2. Define the Role

    • Name: Something descriptive like "Marketing Campaign Manager"
    • Description: Explain what this role is for
    • Resource Type: Choose what this role applies to (Workspace, Project, Team, etc.)

  3. Assign Permissions

    • Select from available permissions
    • Start conservative - you can always add more later
    • Use the search box to find specific permissions

  4. Save and Test

    • Click "Create Role"
    • Assign it to a test user and verify it works as expected

Quick Start Checklist​

Use this checklist to set up RBAC for your team:

  • Access workspace settings and find RBAC section
  • Review default roles and understand what each does
  • Identify 2-3 team members to start with
  • Assign appropriate default roles to these users
  • Set up at least one team with team-based roles
  • Test permissions with a team member
  • Document your role assignments for future reference
  • Plan any custom roles you might need

Common First-Time Patterns​

For a Small Development Team​

  • Tech Lead: Workspace Manager + Project Admin roles
  • Developers: Project Developer + Team Member roles
  • Designers: Project Viewer + Team Member roles

For a Larger Organization​

  • Department Managers: Workspace Manager + Team Lead roles
  • Project Managers: Project Admin + Team Lead roles
  • Individual Contributors: Role specific to their function + Team Member
  • Contractors: Time-limited Project Viewer or Project Developer roles

For Client Access​

  • Client Stakeholders: Project Viewer with time-limited access
  • Client Technical Team: Project Developer with restricted permissions
  • External Consultants: Custom role with minimal workspace access

What's Next?​

Now that you have basic RBAC set up:

  1. Learn Role Management: Deep dive into creating and managing roles
  2. Understand Permissions: Master the permission system
  3. Advanced User Management: Handle complex access scenarios
  4. Explore Common Scenarios: See real-world examples
  5. Troubleshooting Guide: Solve common issues

Getting Help​

  • Can't find RBAC settings? You might not have sufficient permissions. Contact your workspace admin.
  • Permissions not working as expected? Check our troubleshooting guide.
  • Need to handle a complex scenario? Review common scenarios for examples.
  • Still stuck? Contact your system administrator for assistance.

Congratulations! You've set up basic RBAC for your workspace. Your team members now have appropriate access levels, and you can manage permissions efficiently.