Skip to content

feat(api): manage workspace members through the v2 API #9852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waleedlatif1 merged 6 commits into from
Nov 10, 2026
Merged

feat(api): manage workspace members through the v2 API #9852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bd9e3ce
feat(api): update and remove workspace members through the v2 API
waleedlatif1 Nov 10, 2026
f95583c
test(workspaces): prove v2 workspace member management end to end
waleedlatif1 Nov 10, 2026
34a5ca6
test(workspaces): prove v2 member management in-process against Postg…
waleedlatif1 Nov 10, 2026
ebdce71
fix(api): align v2 workspace member errors and keep the old CLI spelling
waleedlatif1 Nov 10, 2026
1b62796
fix(api): keep workspace member operations in the operations registry…
waleedlatif1 Nov 10, 2026
84ac111
fix(docs): keep the shipped workspaces members anchor and classify th…
waleedlatif1 Nov 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 64 additions & 2 deletions apps/docs/content/docs/cli/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8849,12 +8849,12 @@ sim workspaces fork-resources [options]

API request and response schemas: [listWorkspaceForkResources](/api-reference/workspace-sync/listWorkspaceForkResources).

### sim workspaces members
### sim workspaces members list [#sim-workspaces-members]

List workspace members

```bash
sim workspaces members [options]
sim workspaces members list [options]
```

**Options**
Expand All @@ -8869,6 +8869,68 @@ sim workspaces members [options]

API request and response schemas: [listWorkspaceMembers](/api-reference/workspaces/listWorkspaceMembers).

### sim workspaces members remove

Remove workspace member (OAuth login or personal API key required)

This removes the member’s workspace access. If it was their last workspace in the organization, their organization membership is removed and their sessions end.

```bash
sim workspaces members remove <userId> [options]
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |

</CommandTable>

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

API request and response schemas: [removeWorkspaceMember](/api-reference/workspaces/removeWorkspaceMember).

### sim workspaces members update

Update workspace member (OAuth login or personal API key required)

```bash
sim workspaces members update <userId> [options]
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |

</CommandTable>

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--role <value>` | Yes | New workspace role. Inherited organization Admin access, the workspace owner, and the workspace billing account keep Admin and cannot be changed here. Accepted values: `admin`, `write`, `read`. |

</CommandTable>

API request and response schemas: [updateWorkspaceMember](/api-reference/workspaces/updateWorkspaceMember).

### sim workspaces list

List workspaces
Expand Down
64 changes: 63 additions & 1 deletion apps/docs/content/docs/cli/workspaces.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ API request and response schemas: [getWorkspace](/api-reference/workspaces/getWo
### List workspace members

```bash
sim workspaces members [options]
sim workspaces members list [options]
```

**Options**
Expand All @@ -59,6 +59,68 @@ sim workspaces members [options]

API request and response schemas: [listWorkspaceMembers](/api-reference/workspaces/listWorkspaceMembers).

### Update workspace member

OAuth login or personal API key required.

```bash
sim workspaces members update <userId> [options]
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |

</CommandTable>

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `--role <value>` | Yes | New workspace role. Inherited organization Admin access, the workspace owner, and the workspace billing account keep Admin and cannot be changed here. Accepted values: `admin`, `write`, `read`. |

</CommandTable>

API request and response schemas: [updateWorkspaceMember](/api-reference/workspaces/updateWorkspaceMember).

### Remove workspace member

OAuth login or personal API key required.

This removes the member’s workspace access. If it was their last workspace in the organization, their organization membership is removed and their sessions end.

```bash
sim workspaces members remove <userId> [options]
```

**Arguments**

<CommandTable>

| Argument | Required | Description |
| --- | --- | --- |
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |

</CommandTable>

**Options**

<CommandTable>

| Option | Required | Description |
| --- | --- | --- |
| `-y, --yes` | Yes | Confirm this operation. |

</CommandTable>

API request and response schemas: [removeWorkspaceMember](/api-reference/workspaces/removeWorkspaceMember).

### Create workspace invitations

OAuth login or personal API key required.
Expand Down
Loading
Loading