Workspaces
Overview
Workspace onboarding involves creating, updating, and managing workspaces within a project. Workspaces can have different scopes: PRIVATE, PROJECT, and LOCAL. The following sections outline the details and permissions for various workspace-related actions.
Scopes of Workspace
PRIVATE
- Creation: Can be created by anyone with a valid token, provided the token belongs to the current tenant.
- Ownership: The user who creates a private workspace is the owner and admin of the workspace.
- Permissions:
- Owners/Admins can add or remove users and assign roles within the workspace.
- Private workspaces are accessible only to users explicitly added by the owner/admin.
PROJECT
- Creation: Can be created by project admins or tenant admins.
- Accessibility: Any workspace at the project level can be accessed by all users of that project, based on their roles and permissions.
- Permissions:
- Project admins can add or remove users from the workspace.
LOCAL
- Creation: These are the deafault workspaces for a user.
Workspace Management
1. Creating a Workspace
- Action: Create a new workspace.
- Performed by: Tenant Admin, Project Admin.
- Details: Workspaces can be created at the project level by tenant admins or project admins, ensuring proper setup and access control.
2. Updating a Workspace
- Action: Update an existing workspace.
- Performed by: Tenant Admin, Project Admin.
- Details: Both tenant admins and project admins can update workspace details, including adding or removing users and modifying permissions.
3. Deleting a Workspace
- Action: Soft delete a workspace.
- Performed by: Tenant Admin, Project Admin.
- Details: Workspaces can be soft deleted by tenant admins or project admins, allowing for potential recovery if needed.
4. Managing Private Workspaces
4.1 Adding Users to a Private Workspace
- Action: Add users to the workspace.
- Performed by: Workspace Owner/Admin.
- Details: Owners/Admins of private workspaces can add users and assign roles, ensuring proper collaboration within the workspace.
4.2 Removing Users from a Private Workspace
- Action: Soft delete users from the workspace.
- Performed by: Workspace Owner/Admin.
- Details: Owners/Admins can remove users from the workspace, revoking their access while maintaining data integrity.
5. Retrieving Workspaces of a Project
- Action: Get all workspaces of a project.
- Performed by: All users (based on their role/permission).
- Details: Users can retrieve a list of workspaces they are part of within a project, facilitating easy access to relevant workspaces.
6. Retrieving Users of a Workspace
- Action: Get all users of a workspace.
- Performed by: Workspace Owner/Admin.
- Details: Owners/Admins can retrieve a list of all users in the workspace, including their roles and permissions.
7. Retrieving My Workspaces
- Action: Get my workspaces.
- Performed by: All users.
- Details: Users can retrieve a list of workspaces they are part of, including role information, to easily access their relevant workspaces.
This documentation provides a comprehensive guide to workspace onboarding within a project. For detailed instructions and advanced configurations, refer to the relevant sections in the API documentation or contact your system administrator.