Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cymph.io/llms.txt

Use this file to discover all available pages before exploring further.

Workspaces allow you to organise your work within Cymph. They provide isolated environments for playbooks, executions, assets, integrations and presets, making it easy for teams to collaborate without interfering with each other.

Overview

Every user and every organisation has at least one workspace:
  • Individual workspace: A private workspace created automatically for each user. Only the owner can access it — nobody else can be added to an individual workspace.
  • Organisation default workspace: A workspace automatically created for each organisation. All current organisation members are auto-joined to this workspace, and they are auto-removed when they leave the organisation.
Organisation admins can create additional workspaces beyond the default one. These additional workspaces have their own member lists that are managed independently of the organisation’s membership.
Only users with the Admin role in the organisation can create or delete workspaces.
In the free plan, no additional workspaces can be created.

The Workspaces page

The Workspaces page lists all workspaces you have access to. To navigate to it, go to the Organisation section from the navigation menu and select All Workspaces. Each workspace is shown as a card with the following information:
  • The workspace name and logo
  • The organisation it belongs to (and a Default tag if it is the organisation’s default workspace, or an Individual tag if it is a personal workspace)
  • A summary of resources: Playbooks, Executions, Assets, and Presets
  • The list of members (for organisation workspaces)
Clicking on a workspace card opens the workspace detail page, which contains the following tabs: General, Members, Integrations, Deploy History, and Backup.

How to create a workspace

  1. Go to the Workspaces page.
    • From the navigation menu, go to Organisation and then select All Workspaces.
  2. Click the New Workspace button in the top-right corner.
  3. Enter the workspace details.
    • Workspace Name (required): must be unique within the organisation.
    • Description (optional): a short description of the workspace’s purpose.
    • Workspace Logo (optional): upload a logo in PNG, GIF, or JPEG format, up to 5 MB in size.
  4. In the next step, add the initial members of the workspace
    • Select a role for each member you add. By default, if the user is an organisation member, their initial role in the workspace is inherited from their organisation role. If the user is not part of the organisation, they are added as viewers by default.
  5. Click Create Workspace.
The new workspace will appear on the Workspaces page and in the workspace switcher.
Only organisation admins can create new workspaces
Did you know? You can also create a workspace directly from the workspace switcher in the top-left corner of the platform by clicking Create workspace

How to delete a workspace

  1. Go to the Workspaces page.
    • From the navigation menu, go to Organisation and then select All Workspaces.
  2. Hover over the workspace you want to delete.
  3. Click the Delete Workspace button from the menu in the top-right corner.
  4. A confirmation dialog will appear. Confirm the deletion.
The workspace will be permanently deleted and will no longer appear on the Workspaces page or in the workspace switcher.
The organisation’s default workspace cannot be deleted. Individual workspaces cannot be deleted. Only organisation admins can delete workspaces

How to add members to a workspace

Member management applies to additional (non-default) organisation workspaces. For the default workspace, membership is managed automatically based on organisation membership.
  1. Go to the Workspaces page and click on the workspace you want to manage.
  2. Select the Members tab.
  3. Click the Manage Members button in the top-right corner.
  4. Enter the details of the member(s) you want to add.
    • Select the member(s) you want to grant access to this workspace.
    • Set the role that each member will have to this workspace
  5. Click Update Members to confirm.
The Members table will be automatically refreshed to reflect the changes. You can also add external users to the workspace. By default, the Viewer role is assigned to external users.
Only organisation admins can manage workspace members.

How to remove members from a workspace

  1. Go to the Workspaces page and click on the workspace you want to manage.
  2. Select the Members tab.
  3. Click the Manage Members button in the top-right corner.
  4. Locate the member you want to remove from the list.
  5. Click the remove icon next to their entry.
  6. Confirm the removal.
The member will be removed from the workspace and the Members table will be refreshed.

The Members table

The Members tab of a workspace shows a table with the following columns:
  • Name: the name of the member.
  • E-mail Address: the member’s email address.
  • Joined: the time elapsed since the member joined the workspace.
  • Role: the member’s role in the organisation (e.g. Admin, Editor, Collaborator, Viewer).
  • Access: indicates how the member gained access to the workspace. Members who joined through organisation membership are shown as Org. Member.

How to switch between workspaces

You can switch between workspaces at any time from the workspace switcher in the top-left corner of the platform.
  1. Click the workspace name displayed in the top-left corner of the dashboard.
    • A dropdown will appear listing all workspaces available to you, grouped by owner.
  2. Click on the workspace you want to switch to.
The platform will reload in the context of the selected workspace. Alternatively, you can switch to a workspace from its detail page:
  1. Go to the Workspaces page and click on the workspace you want to switch to.
  2. Click the Switch to Workspace button in the top-right corner.
Did you know? The currently active workspace is always shown in the top-left corner of the platform, next to the Cymph logo.