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 b682487
Browse filesBrowse the repository at this point in the historyBrowse files
API request and response schemas: [listWorkspaceForkResources](/api-reference/workspace-sync/listWorkspaceForkResources).
8902
8902
8903
-
### sim workspaces members
8903
+
### sim workspaces members list [#sim-workspaces-members]
8904
8904
8905
8905
List workspace members
8906
8906
8907
8907
```bash
8908
-
sim workspaces members [options]
8908
+
sim workspaces members list [options]
8909
8909
```
8910
8910
8911
8911
**Options**
@@ -8920,6 +8920,68 @@ sim workspaces members [options]
8920
8920
8921
8921
API request and response schemas: [listWorkspaceMembers](/api-reference/workspaces/listWorkspaceMembers).
8922
8922
8923
+
### sim workspaces members remove
8924
+
8925
+
Remove workspace member (OAuth login or personal API key required)
8926
+
8927
+
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.
8928
+
8929
+
```bash
8930
+
sim workspaces members remove <userId> [options]
8931
+
```
8932
+
8933
+
**Arguments**
8934
+
8935
+
<CommandTable>
8936
+
8937
+
| Argument | Required | Description |
8938
+
| --- | --- | --- |
8939
+
|`userId`| Yes | User identifier of the workspace member, as returned by List workspace members. |
8940
+
8941
+
</CommandTable>
8942
+
8943
+
**Options**
8944
+
8945
+
<CommandTable>
8946
+
8947
+
| Option | Required | Description |
8948
+
| --- | --- | --- |
8949
+
|`-y, --yes`| Yes | Confirm this operation. |
8950
+
8951
+
</CommandTable>
8952
+
8953
+
API request and response schemas: [removeWorkspaceMember](/api-reference/workspaces/removeWorkspaceMember).
8954
+
8955
+
### sim workspaces members update
8956
+
8957
+
Update workspace member (OAuth login or personal API key required)
8958
+
8959
+
```bash
8960
+
sim workspaces members update <userId> [options]
8961
+
```
8962
+
8963
+
**Arguments**
8964
+
8965
+
<CommandTable>
8966
+
8967
+
| Argument | Required | Description |
8968
+
| --- | --- | --- |
8969
+
|`userId`| Yes | User identifier of the workspace member, as returned by List workspace members. |
8970
+
8971
+
</CommandTable>
8972
+
8973
+
**Options**
8974
+
8975
+
<CommandTable>
8976
+
8977
+
| Option | Required | Description |
8978
+
| --- | --- | --- |
8979
+
|`--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`. |
8980
+
8981
+
</CommandTable>
8982
+
8983
+
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