Skip to content

Commit 1174092

Browse files
authored
feat(api): manage workspace members through the v2 API (#9852)
1 parent 8577aa4 commit 1174092

29 files changed

Lines changed: 1659 additions & 122 deletions

File tree

‎apps/docs/content/docs/cli/reference.mdx‎

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8849,12 +8849,12 @@ sim workspaces fork-resources [options]
88498849

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

8852-
### sim workspaces members
8852+
### sim workspaces members list [#sim-workspaces-members]
88538853

88548854
List workspace members
88558855

88568856
```bash
8857-
sim workspaces members [options]
8857+
sim workspaces members list [options]
88588858
```
88598859

88608860
**Options**
@@ -8869,6 +8869,68 @@ sim workspaces members [options]
88698869

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

8872+
### sim workspaces members remove
8873+
8874+
Remove workspace member (OAuth login or personal API key required)
8875+
8876+
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.
8877+
8878+
```bash
8879+
sim workspaces members remove <userId> [options]
8880+
```
8881+
8882+
**Arguments**
8883+
8884+
<CommandTable>
8885+
8886+
| Argument | Required | Description |
8887+
| --- | --- | --- |
8888+
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |
8889+
8890+
</CommandTable>
8891+
8892+
**Options**
8893+
8894+
<CommandTable>
8895+
8896+
| Option | Required | Description |
8897+
| --- | --- | --- |
8898+
| `-y, --yes` | Yes | Confirm this operation. |
8899+
8900+
</CommandTable>
8901+
8902+
API request and response schemas: [removeWorkspaceMember](/api-reference/workspaces/removeWorkspaceMember).
8903+
8904+
### sim workspaces members update
8905+
8906+
Update workspace member (OAuth login or personal API key required)
8907+
8908+
```bash
8909+
sim workspaces members update <userId> [options]
8910+
```
8911+
8912+
**Arguments**
8913+
8914+
<CommandTable>
8915+
8916+
| Argument | Required | Description |
8917+
| --- | --- | --- |
8918+
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |
8919+
8920+
</CommandTable>
8921+
8922+
**Options**
8923+
8924+
<CommandTable>
8925+
8926+
| Option | Required | Description |
8927+
| --- | --- | --- |
8928+
| `--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`. |
8929+
8930+
</CommandTable>
8931+
8932+
API request and response schemas: [updateWorkspaceMember](/api-reference/workspaces/updateWorkspaceMember).
8933+
88728934
### sim workspaces list
88738935

88748936
List workspaces

‎apps/docs/content/docs/cli/workspaces.mdx‎

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ API request and response schemas: [getWorkspace](/api-reference/workspaces/getWo
4444
### List workspace members
4545

4646
```bash
47-
sim workspaces members [options]
47+
sim workspaces members list [options]
4848
```
4949

5050
**Options**
@@ -59,6 +59,68 @@ sim workspaces members [options]
5959

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

62+
### Update workspace member
63+
64+
OAuth login or personal API key required.
65+
66+
```bash
67+
sim workspaces members update <userId> [options]
68+
```
69+
70+
**Arguments**
71+
72+
<CommandTable>
73+
74+
| Argument | Required | Description |
75+
| --- | --- | --- |
76+
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |
77+
78+
</CommandTable>
79+
80+
**Options**
81+
82+
<CommandTable>
83+
84+
| Option | Required | Description |
85+
| --- | --- | --- |
86+
| `--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`. |
87+
88+
</CommandTable>
89+
90+
API request and response schemas: [updateWorkspaceMember](/api-reference/workspaces/updateWorkspaceMember).
91+
92+
### Remove workspace member
93+
94+
OAuth login or personal API key required.
95+
96+
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.
97+
98+
```bash
99+
sim workspaces members remove <userId> [options]
100+
```
101+
102+
**Arguments**
103+
104+
<CommandTable>
105+
106+
| Argument | Required | Description |
107+
| --- | --- | --- |
108+
| `userId` | Yes | User identifier of the workspace member, as returned by List workspace members. |
109+
110+
</CommandTable>
111+
112+
**Options**
113+
114+
<CommandTable>
115+
116+
| Option | Required | Description |
117+
| --- | --- | --- |
118+
| `-y, --yes` | Yes | Confirm this operation. |
119+
120+
</CommandTable>
121+
122+
API request and response schemas: [removeWorkspaceMember](/api-reference/workspaces/removeWorkspaceMember).
123+
62124
### Create workspace invitations
63125

64126
OAuth login or personal API key required.

0 commit comments

Comments
 (0)