You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1174092
Browse filesBrowse the repository at this point in the historyBrowse files
API request and response schemas: [listWorkspaceForkResources](/api-reference/workspace-sync/listWorkspaceForkResources).
8851
8851
8852
-
### sim workspaces members
8852
+
### sim workspaces members list [#sim-workspaces-members]
8853
8853
8854
8854
List workspace members
8855
8855
8856
8856
```bash
8857
-
sim workspaces members [options]
8857
+
sim workspaces members list [options]
8858
8858
```
8859
8859
8860
8860
**Options**
@@ -8869,6 +8869,68 @@ sim workspaces members [options]
8869
8869
8870
8870
API request and response schemas: [listWorkspaceMembers](/api-reference/workspaces/listWorkspaceMembers).
8871
8871
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).
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/workspaces.mdx
+63-1Lines changed: 63 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ API request and response schemas: [getWorkspace](/api-reference/workspaces/getWo
44
44
### List workspace members
45
45
46
46
```bash
47
-
sim workspaces members [options]
47
+
sim workspaces members list [options]
48
48
```
49
49
50
50
**Options**
@@ -59,6 +59,68 @@ sim workspaces members [options]
59
59
60
60
API request and response schemas: [listWorkspaceMembers](/api-reference/workspaces/listWorkspaceMembers).
61
61
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).
0 commit comments