|
| 1 | +--- |
| 2 | +title: Organizations |
| 3 | +description: Manage organizations — every subcommand, argument, and flag |
| 4 | +--- |
| 5 | + |
| 6 | +import { CommandTable } from '@/components/ui/command-table' |
| 7 | + |
| 8 | +Every command below also accepts the [global options](/cli/commands#global-options). |
| 9 | + |
| 10 | +## Create organization invitation |
| 11 | + |
| 12 | +```bash |
| 13 | +sim organizations invitations create [options] |
| 14 | +``` |
| 15 | + |
| 16 | +Create Organization Invitation (OAuth login or personal API key required) |
| 17 | + |
| 18 | +**Options** |
| 19 | + |
| 20 | +<CommandTable> |
| 21 | + |
| 22 | +| Option | Required | Description | |
| 23 | +| --- | --- | --- | |
| 24 | +| `--organization <value>` | Yes | Organization identifier. | |
| 25 | +| `--email <value>` | Yes | Email address of the person to invite. | |
| 26 | +| `--role <value>` | No | Organization role to offer. Defaults to member; grants no workspace-specific permissions. Accepted values: `member`, `admin`. | |
| 27 | + |
| 28 | +</CommandTable> |
| 29 | + |
| 30 | +## Get organization invitation |
| 31 | + |
| 32 | +```bash |
| 33 | +sim organizations invitations get <invitationId> [options] |
| 34 | +``` |
| 35 | + |
| 36 | +Get Organization Invitation (OAuth login or personal API key required) |
| 37 | + |
| 38 | +**Arguments** |
| 39 | + |
| 40 | +<CommandTable> |
| 41 | + |
| 42 | +| Argument | Required | Description | |
| 43 | +| --- | --- | --- | |
| 44 | +| `invitationId` | Yes | Invitation identifier. | |
| 45 | + |
| 46 | +</CommandTable> |
| 47 | + |
| 48 | +**Options** |
| 49 | + |
| 50 | +<CommandTable> |
| 51 | + |
| 52 | +| Option | Required | Description | |
| 53 | +| --- | --- | --- | |
| 54 | +| `--organization <value>` | Yes | Organization identifier. | |
| 55 | + |
| 56 | +</CommandTable> |
| 57 | + |
| 58 | +## List organization invitations |
| 59 | + |
| 60 | +```bash |
| 61 | +sim organizations invitations list [options] |
| 62 | +``` |
| 63 | + |
| 64 | +List Organization Invitations (OAuth login or personal API key required) |
| 65 | + |
| 66 | +**Options** |
| 67 | + |
| 68 | +<CommandTable> |
| 69 | + |
| 70 | +| Option | Required | Description | |
| 71 | +| --- | --- | --- | |
| 72 | +| `--organization <value>` | Yes | Organization identifier. | |
| 73 | +| `--search <value>` | No | Case-insensitive substring match against the invitee email. | |
| 74 | +| `--status <value>` | No | Filter by current invitation status. Omit to include all statuses. Accepted values: `pending`, `accepted`, `rejected`, `cancelled`, `expired`. | |
| 75 | +| `--sort-by <value>` | No | Field used to sort the result. Accepted values: `email`, `createdAt`. | |
| 76 | +| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. | |
| 77 | +| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `100`. | |
| 78 | +| `--cursor <value>` | No | Continue from nextCursor returned by a previous result. | |
| 79 | + |
| 80 | +</CommandTable> |
| 81 | + |
| 82 | +## Resend organization invitation |
| 83 | + |
| 84 | +```bash |
| 85 | +sim organizations invitations resend <invitationId> [options] |
| 86 | +``` |
| 87 | + |
| 88 | +Resend Organization Invitation (OAuth login or personal API key required) |
| 89 | + |
| 90 | +**Arguments** |
| 91 | + |
| 92 | +<CommandTable> |
| 93 | + |
| 94 | +| Argument | Required | Description | |
| 95 | +| --- | --- | --- | |
| 96 | +| `invitationId` | Yes | Invitation identifier. | |
| 97 | + |
| 98 | +</CommandTable> |
| 99 | + |
| 100 | +**Options** |
| 101 | + |
| 102 | +<CommandTable> |
| 103 | + |
| 104 | +| Option | Required | Description | |
| 105 | +| --- | --- | --- | |
| 106 | +| `--organization <value>` | Yes | Organization identifier. | |
| 107 | + |
| 108 | +</CommandTable> |
| 109 | + |
| 110 | +## Revoke organization invitation |
| 111 | + |
| 112 | +```bash |
| 113 | +sim organizations invitations revoke <invitationId> [options] |
| 114 | +``` |
| 115 | + |
| 116 | +Revoke Organization Invitation (OAuth login or personal API key required) |
| 117 | + |
| 118 | +**Arguments** |
| 119 | + |
| 120 | +<CommandTable> |
| 121 | + |
| 122 | +| Argument | Required | Description | |
| 123 | +| --- | --- | --- | |
| 124 | +| `invitationId` | Yes | Invitation identifier. | |
| 125 | + |
| 126 | +</CommandTable> |
| 127 | + |
| 128 | +**Options** |
| 129 | + |
| 130 | +<CommandTable> |
| 131 | + |
| 132 | +| Option | Required | Description | |
| 133 | +| --- | --- | --- | |
| 134 | +| `--organization <value>` | Yes | Organization identifier. | |
| 135 | +| `-y, --yes` | Yes | Confirm this operation. | |
| 136 | + |
| 137 | +</CommandTable> |
| 138 | + |
| 139 | +## Get organization |
| 140 | + |
| 141 | +```bash |
| 142 | +sim organizations get <organizationId> |
| 143 | +``` |
| 144 | + |
| 145 | +Get Organization (OAuth login or personal API key required) |
| 146 | + |
| 147 | +**Arguments** |
| 148 | + |
| 149 | +<CommandTable> |
| 150 | + |
| 151 | +| Argument | Required | Description | |
| 152 | +| --- | --- | --- | |
| 153 | +| `organizationId` | Yes | Organization identifier. | |
| 154 | + |
| 155 | +</CommandTable> |
| 156 | + |
| 157 | +## List organization members |
| 158 | + |
| 159 | +```bash |
| 160 | +sim organizations members list [options] |
| 161 | +``` |
| 162 | + |
| 163 | +List Organization Members (OAuth login or personal API key required) |
| 164 | + |
| 165 | +**Options** |
| 166 | + |
| 167 | +<CommandTable> |
| 168 | + |
| 169 | +| Option | Required | Description | |
| 170 | +| --- | --- | --- | |
| 171 | +| `--organization <value>` | Yes | Organization identifier. | |
| 172 | +| `--search <value>` | No | Case-insensitive substring match against member name or email. | |
| 173 | +| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `email`, `joinedAt`. | |
| 174 | +| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. | |
| 175 | +| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. | |
| 176 | + |
| 177 | +</CommandTable> |
| 178 | + |
| 179 | +## Remove organization member |
| 180 | + |
| 181 | +```bash |
| 182 | +sim organizations members remove <userId> [options] |
| 183 | +``` |
| 184 | + |
| 185 | +Remove Organization Member (OAuth login or personal API key required) |
| 186 | + |
| 187 | +**Arguments** |
| 188 | + |
| 189 | +<CommandTable> |
| 190 | + |
| 191 | +| Argument | Required | Description | |
| 192 | +| --- | --- | --- | |
| 193 | +| `userId` | Yes | User identifier of the organization member. | |
| 194 | + |
| 195 | +</CommandTable> |
| 196 | + |
| 197 | +**Options** |
| 198 | + |
| 199 | +<CommandTable> |
| 200 | + |
| 201 | +| Option | Required | Description | |
| 202 | +| --- | --- | --- | |
| 203 | +| `--organization <value>` | Yes | Organization identifier. | |
| 204 | +| `-y, --yes` | Yes | Confirm this operation. | |
| 205 | + |
| 206 | +</CommandTable> |
| 207 | + |
| 208 | +## Update organization member |
| 209 | + |
| 210 | +```bash |
| 211 | +sim organizations members update <userId> [options] |
| 212 | +``` |
| 213 | + |
| 214 | +Update Organization Member (OAuth login or personal API key required) |
| 215 | + |
| 216 | +**Arguments** |
| 217 | + |
| 218 | +<CommandTable> |
| 219 | + |
| 220 | +| Argument | Required | Description | |
| 221 | +| --- | --- | --- | |
| 222 | +| `userId` | Yes | User identifier of the organization member. | |
| 223 | + |
| 224 | +</CommandTable> |
| 225 | + |
| 226 | +**Options** |
| 227 | + |
| 228 | +<CommandTable> |
| 229 | + |
| 230 | +| Option | Required | Description | |
| 231 | +| --- | --- | --- | |
| 232 | +| `--organization <value>` | Yes | Organization identifier. | |
| 233 | +| `--role <value>` | Yes | New organization role. Ownership transfers use a separate operation. Accepted values: `member`, `admin`. | |
| 234 | + |
| 235 | +</CommandTable> |
| 236 | + |
| 237 | +## List organizations |
| 238 | + |
| 239 | +```bash |
| 240 | +sim organizations list [options] |
| 241 | +``` |
| 242 | + |
| 243 | +List Organizations (OAuth login or personal API key required) |
| 244 | + |
| 245 | +**Options** |
| 246 | + |
| 247 | +<CommandTable> |
| 248 | + |
| 249 | +| Option | Required | Description | |
| 250 | +| --- | --- | --- | |
| 251 | +| `--search <value>` | No | Case-insensitive substring match against the organization name. | |
| 252 | +| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `createdAt`. | |
| 253 | +| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. | |
| 254 | +| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. | |
| 255 | + |
| 256 | +</CommandTable> |
| 257 | + |
| 258 | +## List organization workspaces |
| 259 | + |
| 260 | +```bash |
| 261 | +sim organizations workspaces [options] |
| 262 | +``` |
| 263 | + |
| 264 | +List Organization Workspaces (OAuth login or personal API key required) |
| 265 | + |
| 266 | +**Options** |
| 267 | + |
| 268 | +<CommandTable> |
| 269 | + |
| 270 | +| Option | Required | Description | |
| 271 | +| --- | --- | --- | |
| 272 | +| `--organization <value>` | Yes | Organization identifier. | |
| 273 | +| `--search <value>` | No | Case-insensitive substring match against the workspace name. | |
| 274 | +| `--sort-by <value>` | No | Field used to sort the result. Sorting by `name` is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: `name`, `id`. | |
| 275 | +| `--sort-order <value>` | No | Sort direction. Accepted values: `asc`, `desc`. | |
| 276 | +| `--limit <n>` | No | Maximum items to return (0 for everything). Defaults to `0`. | |
| 277 | + |
| 278 | +</CommandTable> |
0 commit comments