For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workspace

This file outlines the Flashgate API's workspace management features, including creating, updating, listing, and managing workspaces that group users and resources within an organization. Workspaces support role-based access control with READ, WRITE, and ADMIN permissions.

To perform these operations, you must be authenticated by means of one of the following methods: BearerAuth.

Workspace API Calls

Method
API Reference
Description

POST/workspace

Create a new workspace for the authenticated user's organization.

GET/workspace

Retrieve all workspaces the authenticated user can access.

GET/workspace/{id}

Retrieve a specific workspace by ID.

PUT/workspace/{id}

Update an existing workspace's configuration.

DELETE/workspace/{id}

Delete a workspace (soft delete).

POST/workspace/{id}/users

Add a user to a workspace with specified role.

PUT/workspace/{id}/users/{userId}

Update a user's role in a workspace.

DELETE/workspace/{id}/users/{userId}

Remove a user from a workspace.

Workspace Access Types

Access Type
Description

READ

Read-only access to workspace resources

WRITE

Read and write access to workspace resources

ADMIN

Full administrative access including user management

Workspace Management Permissions

  • Organization Owners, Administrators, and Workspace Managers can create new workspaces

  • Workspace Admins can manage workspace users and update workspace settings

  • Workspace Admins can delete workspaces (only if they contain no buckets or repositories)

  • Users must have validated accounts to perform workspace operations

Last updated

Was this helpful?