Skip to main content

Managing Workspaces

Organize your projects and collaborate with team members using workspaces.

What is a Workspace?​

A Workspace is your top-level organizational unit and multi-tenant container. It serves as a security boundary for all resources. Everything you create in SyAuth belongs to a specific workspace.

A workspace contains:

  • OAuth Clients: Your applications (labeled as OAuth Clients in the sidebar).
  • Users: End-users who register and log in to your applications.
  • Groups: Access control groups for your users.
  • API Tokens: Workspace-scoped tokens for server-side API access.
  • Email Templates: Custom templates for welcome, verification, and reset emails.
  • OAuth Providers: External social login connections (Google, GitHub, etc.).
  • Custom Databases: External postgresql/mysql connections for user data.
  • Team Members: Developers you've invited to collaborate on this workspace.

Switching Workspaces​

You can switch between workspaces at any time using the Workspace Selector located in the top header of the dashboard.

  1. Click the workspace name in the header (e.g., "Default Workspace").
  2. Select another workspace from the dropdown list.
  3. The dashboard will automatically refresh to show the resources for that specific workspace.

Managing Workspaces​

To see a list of all your workspaces, create new ones, or manage existing ones:

  1. Click Workspaces in the main sidebar.
  2. Here you can see workspaces you Own and workspaces where you are a Member.

Creating a Workspace​

  1. Go to the Workspaces page from the sidebar.
  2. Click the Create Workspace button at the top right.
  3. Enter a descriptive name (e.g., "Mobile App - Prod").
  4. Click Create.

You will automatically become the Owner of any workspace you create.

Workspace Settings​

Currently, workspace settings (like the name) can be managed directly from the Workspaces page:

  1. Go to the Workspaces page from the sidebar.
  2. Find the workspace you want to edit.
  3. Click the Edit button.
  4. Update the name and click Save.

Team Collaboration​

Inviting Team Members​

  1. Go to the Workspaces page from the sidebar.
  2. Click Manage Members on the workspace you want to manage.
  3. On the members page, click Invite Member.
  4. Enter their email address.
  5. Click Send Invitation.

Newly invited members are assigned the Member role by default.

Invitation Process​

  1. Team member receives email invitation
  2. They click the invitation link
  3. They sign up or sign in
  4. They're added to the workspace

Pending Invitations​

View and manage pending invitations:

  • See who hasn't accepted
  • Resend invitations
  • Cancel pending invitations

Team Roles​

RolePermissions
OwnerFull access, manage members, delete workspace
MemberCRUD on resources, cannot manage team

Managing Team Members​

View Members​

  1. Go to the Workspaces page from the sidebar.
  2. Click Manage Members on the workspace.
  3. View the member list with assigned roles.

Remove Member​

  1. Find the member in the list.
  2. Click Remove.
  3. Confirm the removal.

Workspace Resources​

Each workspace has its own:

ResourceScoped
OAuth Clients✅
Users✅
Groups✅
API Tokens✅
Email Templates✅
Custom Databases✅
Providers✅

Deleting a Workspace​

To delete a workspace, you must be the Owner.

  1. Go to the Workspaces page from the sidebar.
  2. Locate the workspace you want to delete in the Owned Workspaces section.
  3. Click the Delete button on the workspace card.
  4. Review the warning and confirm the deletion in the modal.
Irreversible Action

Deleting a workspace will permanently delete all associated OAuth clients, users, groups, API tokens, email templates, and settings. This action cannot be undone.

Best Practices​

PracticeDescription
Separate environmentsUse different workspaces for dev/staging/prod
Limit ownersOnly trusted members should be owners
Regular auditsReview team access periodically
Descriptive namesName workspaces clearly

Next Steps​