@zitadel/cli 1.0.0-alpha.23 → 1.0.0-alpha.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +513 -655
- package/SKILLS.md +52 -45
- package/dist/index.mjs +230 -512
- package/dist/index.mjs.map +1 -1
- package/oclif.manifest.json +25 -581
- package/package.json +9 -6
package/README.md
CHANGED
|
@@ -35,9 +35,11 @@ npm run dev
|
|
|
35
35
|
under `.zitadel/local/` (SQLite by default). Remote-server setup can use
|
|
36
36
|
`--server <url>` without starting a local runtime. Use `--runtime docker`,
|
|
37
37
|
`--image`, or `ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
|
|
38
|
+
`start` also creates a local admin, `admin@zitadel.localhost`, and ends by
|
|
39
|
+
printing a one-time sign-in link for the management console.
|
|
38
40
|
`setup --server local` creates a project on that local server, asks which
|
|
39
|
-
framework to scaffold when the directory is fresh
|
|
40
|
-
|
|
41
|
+
framework to scaffold when the directory is fresh, writes the app into the
|
|
42
|
+
current directory, and scaffolds the framework's
|
|
41
43
|
idiomatic auth routes plus the proxy layer — for Next.js that means
|
|
42
44
|
`app/login`, `app/register`, `app/profile`, and `proxy.ts` for Next 16+ or
|
|
43
45
|
`middleware.ts` for older versions; other frameworks get their equivalents
|
|
@@ -46,6 +48,11 @@ embedding posture from the app instead of assuming a fresh skeleton: the
|
|
|
46
48
|
scaffolded pages take the `variant="widget"` posture inside your app's own
|
|
47
49
|
shell, recorded in the scaffold manifest and verified by `doctor`. Fresh
|
|
48
50
|
scaffolds also replace the starter home page with a redirect to `/login`.
|
|
51
|
+
Against a local server started with the default platform bootstrap, setup also
|
|
52
|
+
attaches the new project to the local admin's team, so the project is owned
|
|
53
|
+
from the start and `zitadel claim` reports it as already owned. If you opted
|
|
54
|
+
out with `NEXTGEN_PLATFORM_BOOTSTRAP_PROJECT=false`, there is no local admin
|
|
55
|
+
and the project has no owning team; that server cannot claim projects.
|
|
49
56
|
Setup writes `.env.local` and `.zitadel/`, and installs
|
|
50
57
|
dependencies with the detected package manager. Pass `--skip-install` to install
|
|
51
58
|
them yourself. The project's default user schema and login flow are provisioned
|
|
@@ -54,7 +61,9 @@ from versioned local defaults; setup writes editable copies into
|
|
|
54
61
|
`.zitadel/flows/default-login.json`, uploads them through the schema and flow
|
|
55
62
|
APIs, then seeds `.zitadel/state.json` so `zitadel plan` is immediately empty.
|
|
56
63
|
Open the dev server URL printed by your framework, register a user, log out,
|
|
57
|
-
log back in, and end on the signed-in profile page.
|
|
64
|
+
log back in, and end on the signed-in profile page. That user is an end user
|
|
65
|
+
of your app. The management console is a separate sign-in: run
|
|
66
|
+
`zitadel console` for a fresh one-time link as the local admin.
|
|
58
67
|
|
|
59
68
|
For a reproducible tester report, use the exact alpha train from the GitHub
|
|
60
69
|
Release:
|
|
@@ -76,7 +85,7 @@ plus a `login.liquid` LiquidJS template), then re-run `zitadel plan` and
|
|
|
76
85
|
`zitadel apply`. Server-provisioned defaults remain a fallback for non-CLI
|
|
77
86
|
project creation, but CLI-created projects are authored from local files first.
|
|
78
87
|
Login templates are supported: scaffold them with the `branding eject` command
|
|
79
|
-
(`--design centered|
|
|
88
|
+
(`--design centered|minimal`); setup never does;
|
|
80
89
|
every edit publishes a new immutable branding revision and the login serves
|
|
81
90
|
the newest one. Flows work the same way: every edit publishes a new immutable
|
|
82
91
|
flow revision. A page that pins `flow-name` gets that flow's newest revision. A
|
|
@@ -89,18 +98,23 @@ and agent UIs may display stderr package-manager progress together with stdout.
|
|
|
89
98
|
|
|
90
99
|
## Other commands
|
|
91
100
|
|
|
92
|
-
- `zitadel claim
|
|
101
|
+
- `zitadel claim`: claim the project to make it permanent (opens the claim
|
|
93
102
|
page, polls for completion; the claim then shows in `setup`, `status`, and
|
|
94
103
|
`doctor`)
|
|
95
|
-
- `zitadel
|
|
104
|
+
- `zitadel console`: print a fresh one-time sign-in link for the local
|
|
105
|
+
console as `admin@zitadel.localhost` and open it in a browser
|
|
106
|
+
(`--no-open` prints the link only)
|
|
107
|
+
- `zitadel doctor`: verify the local runtime and generated project files
|
|
96
108
|
(including scaffold drift and dependency-version alignment)
|
|
97
|
-
- `zitadel status
|
|
98
|
-
- `zitadel plan
|
|
99
|
-
- `zitadel apply
|
|
100
|
-
- `zitadel branding eject
|
|
101
|
-
- `zitadel schemas list
|
|
102
|
-
- `zitadel
|
|
103
|
-
-
|
|
109
|
+
- `zitadel status`: summarise the local runtime and project
|
|
110
|
+
- `zitadel plan`: validate config and preview sync changes without mutation
|
|
111
|
+
- `zitadel apply`: validate and upload repo config to Zitadel
|
|
112
|
+
- `zitadel branding eject`: scaffold an editable login template from a design
|
|
113
|
+
- `zitadel schemas list`: list the project's user schemas
|
|
114
|
+
- `zitadel variables list|get|set|delete`: manage the project's variables and
|
|
115
|
+
secrets (`--project-level`)
|
|
116
|
+
- `zitadel eject`: remove what setup wrote (alias: `zitadel uninstall`)
|
|
117
|
+
- `zitadel start|stop|logs|reset`: manage the local runtime
|
|
104
118
|
|
|
105
119
|
The full agent-facing contract (JSON envelope, posture rules, claim flow,
|
|
106
120
|
doctor repair) is [`SKILLS.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/SKILLS.md),
|
|
@@ -180,21 +194,18 @@ Validate and upload repo config to the platform.
|
|
|
180
194
|
```
|
|
181
195
|
USAGE
|
|
182
196
|
$ zitadel apply [--json] [-c <value>] [-s <value>] [-n]
|
|
183
|
-
[--dry-run] [--verbose] [--debug] [--telemetry]
|
|
184
|
-
development|preview|production]
|
|
197
|
+
[--dry-run] [--verbose] [--debug] [--telemetry]
|
|
185
198
|
|
|
186
199
|
FLAGS
|
|
187
|
-
-c, --cwd=<value>
|
|
188
|
-
-
|
|
189
|
-
|
|
190
|
-
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
--
|
|
194
|
-
|
|
195
|
-
--
|
|
196
|
-
--no-telemetry.
|
|
197
|
-
--verbose Verbose logging.
|
|
200
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
201
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
202
|
+
an agent.
|
|
203
|
+
-s, --server=<value> Override the resolved server URL.
|
|
204
|
+
--debug Debug logging.
|
|
205
|
+
--dry-run Preview without mutating files or the platform.
|
|
206
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
207
|
+
--no-telemetry.
|
|
208
|
+
--verbose Verbose logging.
|
|
198
209
|
|
|
199
210
|
GLOBAL FLAGS
|
|
200
211
|
--json Format output as json.
|
|
@@ -242,7 +253,7 @@ Take ownership of the login template: scaffold .zitadel/branding/ from a shipped
|
|
|
242
253
|
USAGE
|
|
243
254
|
$ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
|
|
244
255
|
[--dry-run] [--verbose] [--debug] [--telemetry] [-f] [--design
|
|
245
|
-
centered|
|
|
256
|
+
centered|minimal]
|
|
246
257
|
|
|
247
258
|
FLAGS
|
|
248
259
|
-c, --cwd=<value> Project directory to operate on.
|
|
@@ -252,7 +263,7 @@ FLAGS
|
|
|
252
263
|
-s, --server=<value> Override the resolved server URL.
|
|
253
264
|
--debug Debug logging.
|
|
254
265
|
--design=<option> Design to start from (default: centered).
|
|
255
|
-
<options: centered|
|
|
266
|
+
<options: centered|minimal>
|
|
256
267
|
--dry-run Preview without mutating files or the platform.
|
|
257
268
|
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
258
269
|
--no-telemetry.
|
|
@@ -273,27 +284,23 @@ Get one branding revision by id.
|
|
|
273
284
|
```
|
|
274
285
|
USAGE
|
|
275
286
|
$ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
276
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
277
|
-
development|preview|production]
|
|
287
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
278
288
|
|
|
279
289
|
ARGUMENTS
|
|
280
290
|
ID branding revision id
|
|
281
291
|
|
|
282
292
|
FLAGS
|
|
283
|
-
-c, --cwd=<value>
|
|
284
|
-
-
|
|
285
|
-
|
|
286
|
-
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
--
|
|
290
|
-
|
|
291
|
-
--
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
295
|
-
--no-telemetry.
|
|
296
|
-
--verbose Verbose logging.
|
|
293
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
294
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
295
|
+
an agent.
|
|
296
|
+
-s, --server=<value> Override the resolved server URL.
|
|
297
|
+
--debug Debug logging.
|
|
298
|
+
--dry-run Preview without mutating files or the platform.
|
|
299
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
300
|
+
the resource's own; `--json` is unaffected.
|
|
301
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
302
|
+
--no-telemetry.
|
|
303
|
+
--verbose Verbose logging.
|
|
297
304
|
|
|
298
305
|
GLOBAL FLAGS
|
|
299
306
|
--json Format output as json.
|
|
@@ -315,25 +322,22 @@ List branding.
|
|
|
315
322
|
USAGE
|
|
316
323
|
$ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
|
|
317
324
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>] [--plain]
|
|
318
|
-
[-e development|preview|production]
|
|
319
325
|
|
|
320
326
|
FLAGS
|
|
321
|
-
-c, --cwd=<value>
|
|
322
|
-
-
|
|
323
|
-
|
|
324
|
-
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
--
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
--
|
|
333
|
-
|
|
334
|
-
--
|
|
335
|
-
--no-telemetry.
|
|
336
|
-
--verbose Verbose logging.
|
|
327
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
328
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
329
|
+
an agent.
|
|
330
|
+
-s, --server=<value> Override the resolved server URL.
|
|
331
|
+
--debug Debug logging.
|
|
332
|
+
--dry-run Preview without mutating files or the platform.
|
|
333
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
334
|
+
id,attributes.email). Defaults to the resource's own
|
|
335
|
+
columns; `--json` is unaffected.
|
|
336
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
337
|
+
when stdout is not a terminal.
|
|
338
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
339
|
+
--no-telemetry.
|
|
340
|
+
--verbose Verbose logging.
|
|
337
341
|
|
|
338
342
|
GLOBAL FLAGS
|
|
339
343
|
--json Format output as json.
|
|
@@ -520,27 +524,23 @@ Get one environment by id.
|
|
|
520
524
|
```
|
|
521
525
|
USAGE
|
|
522
526
|
$ zitadel environments get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
523
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
524
|
-
development|preview|production]
|
|
527
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
525
528
|
|
|
526
529
|
ARGUMENTS
|
|
527
530
|
NAME environment name
|
|
528
531
|
|
|
529
532
|
FLAGS
|
|
530
|
-
-c, --cwd=<value>
|
|
531
|
-
-
|
|
532
|
-
|
|
533
|
-
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
--
|
|
537
|
-
|
|
538
|
-
--
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
542
|
-
--no-telemetry.
|
|
543
|
-
--verbose Verbose logging.
|
|
533
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
534
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
535
|
+
an agent.
|
|
536
|
+
-s, --server=<value> Override the resolved server URL.
|
|
537
|
+
--debug Debug logging.
|
|
538
|
+
--dry-run Preview without mutating files or the platform.
|
|
539
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
540
|
+
the resource's own; `--json` is unaffected.
|
|
541
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
542
|
+
--no-telemetry.
|
|
543
|
+
--verbose Verbose logging.
|
|
544
544
|
|
|
545
545
|
GLOBAL FLAGS
|
|
546
546
|
--json Format output as json.
|
|
@@ -562,29 +562,26 @@ List environments.
|
|
|
562
562
|
USAGE
|
|
563
563
|
$ zitadel environments list [--json] [-c <value>] [-s <value>] [-n]
|
|
564
564
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
565
|
-
--page-token <value>] [--fields <value>] [--plain]
|
|
566
|
-
development|preview|production]
|
|
565
|
+
--page-token <value>] [--fields <value>] [--plain]
|
|
567
566
|
|
|
568
567
|
FLAGS
|
|
569
|
-
-a, --all
|
|
570
|
-
-c, --cwd=<value>
|
|
571
|
-
-
|
|
572
|
-
|
|
573
|
-
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
--
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
--
|
|
582
|
-
|
|
583
|
-
--
|
|
584
|
-
|
|
585
|
-
--
|
|
586
|
-
--no-telemetry.
|
|
587
|
-
--verbose Verbose logging.
|
|
568
|
+
-a, --all Fetch every page instead of one.
|
|
569
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
570
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
571
|
+
as an agent.
|
|
572
|
+
-s, --server=<value> Override the resolved server URL.
|
|
573
|
+
--debug Debug logging.
|
|
574
|
+
--dry-run Preview without mutating files or the platform.
|
|
575
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
576
|
+
id,attributes.email). Defaults to the resource's own
|
|
577
|
+
columns; `--json` is unaffected.
|
|
578
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
579
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
580
|
+
--plain Tab-separated rows with no header, for piping.
|
|
581
|
+
Implied when stdout is not a terminal.
|
|
582
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
583
|
+
--no-telemetry.
|
|
584
|
+
--verbose Verbose logging.
|
|
588
585
|
|
|
589
586
|
GLOBAL FLAGS
|
|
590
587
|
--json Format output as json.
|
|
@@ -605,27 +602,23 @@ Get one event by id.
|
|
|
605
602
|
```
|
|
606
603
|
USAGE
|
|
607
604
|
$ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
608
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
609
|
-
development|preview|production]
|
|
605
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
610
606
|
|
|
611
607
|
ARGUMENTS
|
|
612
608
|
ID event id
|
|
613
609
|
|
|
614
610
|
FLAGS
|
|
615
|
-
-c, --cwd=<value>
|
|
616
|
-
-
|
|
617
|
-
|
|
618
|
-
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
--
|
|
622
|
-
|
|
623
|
-
--
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
627
|
-
--no-telemetry.
|
|
628
|
-
--verbose Verbose logging.
|
|
611
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
612
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
613
|
+
an agent.
|
|
614
|
+
-s, --server=<value> Override the resolved server URL.
|
|
615
|
+
--debug Debug logging.
|
|
616
|
+
--dry-run Preview without mutating files or the platform.
|
|
617
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
618
|
+
the resource's own; `--json` is unaffected.
|
|
619
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
620
|
+
--no-telemetry.
|
|
621
|
+
--verbose Verbose logging.
|
|
629
622
|
|
|
630
623
|
GLOBAL FLAGS
|
|
631
624
|
--json Format output as json.
|
|
@@ -648,7 +641,7 @@ USAGE
|
|
|
648
641
|
$ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
|
|
649
642
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
650
643
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
651
|
-
[--sort <value>]
|
|
644
|
+
[--sort <value>]
|
|
652
645
|
|
|
653
646
|
FLAGS
|
|
654
647
|
-a, --all
|
|
@@ -657,10 +650,6 @@ FLAGS
|
|
|
657
650
|
-c, --cwd=<value>
|
|
658
651
|
Project directory to operate on.
|
|
659
652
|
|
|
660
|
-
-e, --environment=<option>
|
|
661
|
-
Target environment (default: development).
|
|
662
|
-
<options: development|preview|production>
|
|
663
|
-
|
|
664
653
|
-n, --non-interactive
|
|
665
654
|
Disable prompts. Required when scripting or running as an agent.
|
|
666
655
|
|
|
@@ -725,27 +714,23 @@ Get one flow definition by id.
|
|
|
725
714
|
```
|
|
726
715
|
USAGE
|
|
727
716
|
$ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
|
|
728
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
729
|
-
development|preview|production]
|
|
717
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
730
718
|
|
|
731
719
|
ARGUMENTS
|
|
732
720
|
FLOW flow name (newest revision) or revision id
|
|
733
721
|
|
|
734
722
|
FLAGS
|
|
735
|
-
-c, --cwd=<value>
|
|
736
|
-
-
|
|
737
|
-
|
|
738
|
-
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
--
|
|
742
|
-
|
|
743
|
-
--
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
747
|
-
--no-telemetry.
|
|
748
|
-
--verbose Verbose logging.
|
|
723
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
724
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
725
|
+
an agent.
|
|
726
|
+
-s, --server=<value> Override the resolved server URL.
|
|
727
|
+
--debug Debug logging.
|
|
728
|
+
--dry-run Preview without mutating files or the platform.
|
|
729
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
730
|
+
the resource's own; `--json` is unaffected.
|
|
731
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
732
|
+
--no-telemetry.
|
|
733
|
+
--verbose Verbose logging.
|
|
749
734
|
|
|
750
735
|
GLOBAL FLAGS
|
|
751
736
|
--json Format output as json.
|
|
@@ -767,33 +752,29 @@ List flow-definitions.
|
|
|
767
752
|
USAGE
|
|
768
753
|
$ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
|
|
769
754
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
770
|
-
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
771
|
-
development|preview|production]
|
|
755
|
+
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
772
756
|
|
|
773
757
|
FLAGS
|
|
774
|
-
-a, --all
|
|
775
|
-
-c, --cwd=<value>
|
|
776
|
-
-
|
|
777
|
-
|
|
778
|
-
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
--
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
--
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
795
|
-
--no-telemetry.
|
|
796
|
-
--verbose Verbose logging.
|
|
758
|
+
-a, --all Fetch every page instead of one.
|
|
759
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
760
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
761
|
+
as an agent.
|
|
762
|
+
-s, --server=<value> Override the resolved server URL.
|
|
763
|
+
--debug Debug logging.
|
|
764
|
+
--dry-run Preview without mutating files or the platform.
|
|
765
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
766
|
+
id,attributes.email). Defaults to the resource's own
|
|
767
|
+
columns; `--json` is unaffected.
|
|
768
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
769
|
+
to equals). Fields: name (equals), purpose (equals),
|
|
770
|
+
revisions (equals; values all|latest).
|
|
771
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
772
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
773
|
+
--plain Tab-separated rows with no header, for piping.
|
|
774
|
+
Implied when stdout is not a terminal.
|
|
775
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
776
|
+
--no-telemetry.
|
|
777
|
+
--verbose Verbose logging.
|
|
797
778
|
|
|
798
779
|
GLOBAL FLAGS
|
|
799
780
|
--json Format output as json.
|
|
@@ -816,23 +797,20 @@ Create a grant.
|
|
|
816
797
|
```
|
|
817
798
|
USAGE
|
|
818
799
|
$ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
|
|
819
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--
|
|
820
|
-
[--
|
|
821
|
-
<value>]
|
|
822
|
-
development|preview|production]
|
|
800
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--relation
|
|
801
|
+
viewer|editor|admin] [--expires-at <value>] [--data <value> | --file
|
|
802
|
+
<value>]
|
|
823
803
|
|
|
824
804
|
FLAGS
|
|
825
|
-
-c, --cwd=<value>
|
|
826
|
-
-
|
|
827
|
-
|
|
828
|
-
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
--
|
|
832
|
-
|
|
833
|
-
--
|
|
834
|
-
--no-telemetry.
|
|
835
|
-
--verbose Verbose logging.
|
|
805
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
806
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
807
|
+
an agent.
|
|
808
|
+
-s, --server=<value> Override the resolved server URL.
|
|
809
|
+
--debug Debug logging.
|
|
810
|
+
--dry-run Preview without mutating files or the platform.
|
|
811
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
812
|
+
--no-telemetry.
|
|
813
|
+
--verbose Verbose logging.
|
|
836
814
|
|
|
837
815
|
RAW BODY FLAGS
|
|
838
816
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -845,20 +823,13 @@ GLOBAL FLAGS
|
|
|
845
823
|
--json Format output as json.
|
|
846
824
|
|
|
847
825
|
REQUIRED FIELD FLAGS
|
|
848
|
-
--
|
|
849
|
-
|
|
850
|
-
--principal-type=<option> (required) Kind of principal to bind.
|
|
851
|
-
<options: user|team>
|
|
852
|
-
--relation=<option> (required) Catalog relation on `object_type`
|
|
853
|
-
`project`.
|
|
854
|
-
<options: viewer|editor|admin>
|
|
826
|
+
--relation=<option> (required) Catalog relation on `object_type` `project`.
|
|
827
|
+
<options: viewer|editor|admin>
|
|
855
828
|
|
|
856
829
|
DESCRIPTION
|
|
857
830
|
Create a grant.
|
|
858
831
|
|
|
859
832
|
EXAMPLES
|
|
860
|
-
$ zitadel grants create --principal-type user --principal-id <principal_id> --relation viewer --json
|
|
861
|
-
|
|
862
833
|
$ zitadel grants create --data '{...}' --json
|
|
863
834
|
|
|
864
835
|
$ zitadel grants create --file ./grant.json
|
|
@@ -871,26 +842,23 @@ Delete a grant by id.
|
|
|
871
842
|
```
|
|
872
843
|
USAGE
|
|
873
844
|
$ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
874
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
875
|
-
development|preview|production]
|
|
845
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
876
846
|
|
|
877
847
|
ARGUMENTS
|
|
878
848
|
ID grant id
|
|
879
849
|
|
|
880
850
|
FLAGS
|
|
881
|
-
-c, --cwd=<value>
|
|
882
|
-
-
|
|
883
|
-
|
|
884
|
-
-
|
|
885
|
-
|
|
886
|
-
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
--
|
|
890
|
-
|
|
891
|
-
--
|
|
892
|
-
--no-telemetry.
|
|
893
|
-
--verbose Verbose logging.
|
|
851
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
852
|
+
-f, --force Delete the grant without the confirmation prompt.
|
|
853
|
+
Required when non-interactive.
|
|
854
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
855
|
+
an agent.
|
|
856
|
+
-s, --server=<value> Override the resolved server URL.
|
|
857
|
+
--debug Debug logging.
|
|
858
|
+
--dry-run Preview without mutating files or the platform.
|
|
859
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
860
|
+
--no-telemetry.
|
|
861
|
+
--verbose Verbose logging.
|
|
894
862
|
|
|
895
863
|
GLOBAL FLAGS
|
|
896
864
|
--json Format output as json.
|
|
@@ -909,27 +877,23 @@ Get one grant by id.
|
|
|
909
877
|
```
|
|
910
878
|
USAGE
|
|
911
879
|
$ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
912
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
913
|
-
development|preview|production]
|
|
880
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
914
881
|
|
|
915
882
|
ARGUMENTS
|
|
916
883
|
ID grant id
|
|
917
884
|
|
|
918
885
|
FLAGS
|
|
919
|
-
-c, --cwd=<value>
|
|
920
|
-
-
|
|
921
|
-
|
|
922
|
-
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
--
|
|
926
|
-
|
|
927
|
-
--
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
931
|
-
--no-telemetry.
|
|
932
|
-
--verbose Verbose logging.
|
|
886
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
887
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
888
|
+
an agent.
|
|
889
|
+
-s, --server=<value> Override the resolved server URL.
|
|
890
|
+
--debug Debug logging.
|
|
891
|
+
--dry-run Preview without mutating files or the platform.
|
|
892
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
893
|
+
the resource's own; `--json` is unaffected.
|
|
894
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
895
|
+
--no-telemetry.
|
|
896
|
+
--verbose Verbose logging.
|
|
933
897
|
|
|
934
898
|
GLOBAL FLAGS
|
|
935
899
|
--json Format output as json.
|
|
@@ -952,7 +916,7 @@ USAGE
|
|
|
952
916
|
$ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
|
|
953
917
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
954
918
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
955
|
-
[--sort <value>]
|
|
919
|
+
[--sort <value>]
|
|
956
920
|
|
|
957
921
|
FLAGS
|
|
958
922
|
-a, --all
|
|
@@ -961,10 +925,6 @@ FLAGS
|
|
|
961
925
|
-c, --cwd=<value>
|
|
962
926
|
Project directory to operate on.
|
|
963
927
|
|
|
964
|
-
-e, --environment=<option>
|
|
965
|
-
Target environment (default: development).
|
|
966
|
-
<options: development|preview|production>
|
|
967
|
-
|
|
968
928
|
-n, --non-interactive
|
|
969
929
|
Disable prompts. Required when scripting or running as an agent.
|
|
970
930
|
|
|
@@ -984,10 +944,10 @@ FLAGS
|
|
|
984
944
|
--filter=<value>...
|
|
985
945
|
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
986
946
|
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
987
|
-
qual|greater_than|greater_than_or_equal),
|
|
947
|
+
qual|greater_than|greater_than_or_equal), user_id
|
|
988
948
|
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
989
|
-
r_than|greater_than_or_equal),
|
|
990
|
-
|
|
949
|
+
r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
|
|
950
|
+
ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
991
951
|
relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
|
|
992
952
|
al|greater_than|greater_than_or_equal), expires_at
|
|
993
953
|
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
@@ -1054,20 +1014,18 @@ Create an identity provider connection.
|
|
|
1054
1014
|
USAGE
|
|
1055
1015
|
$ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
|
|
1056
1016
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--data <value> | --file
|
|
1057
|
-
<value>]
|
|
1017
|
+
<value>]
|
|
1058
1018
|
|
|
1059
1019
|
FLAGS
|
|
1060
|
-
-c, --cwd=<value>
|
|
1061
|
-
-
|
|
1062
|
-
|
|
1063
|
-
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
--
|
|
1067
|
-
|
|
1068
|
-
--
|
|
1069
|
-
--no-telemetry.
|
|
1070
|
-
--verbose Verbose logging.
|
|
1020
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1021
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1022
|
+
an agent.
|
|
1023
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1024
|
+
--debug Debug logging.
|
|
1025
|
+
--dry-run Preview without mutating files or the platform.
|
|
1026
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1027
|
+
--no-telemetry.
|
|
1028
|
+
--verbose Verbose logging.
|
|
1071
1029
|
|
|
1072
1030
|
RAW BODY FLAGS
|
|
1073
1031
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1092,27 +1050,23 @@ Get one identity provider connection by id.
|
|
|
1092
1050
|
```
|
|
1093
1051
|
USAGE
|
|
1094
1052
|
$ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1095
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1096
|
-
development|preview|production]
|
|
1053
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1097
1054
|
|
|
1098
1055
|
ARGUMENTS
|
|
1099
1056
|
ID identity provider connection id
|
|
1100
1057
|
|
|
1101
1058
|
FLAGS
|
|
1102
|
-
-c, --cwd=<value>
|
|
1103
|
-
-
|
|
1104
|
-
|
|
1105
|
-
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
--
|
|
1109
|
-
|
|
1110
|
-
--
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1114
|
-
--no-telemetry.
|
|
1115
|
-
--verbose Verbose logging.
|
|
1059
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1060
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1061
|
+
an agent.
|
|
1062
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1063
|
+
--debug Debug logging.
|
|
1064
|
+
--dry-run Preview without mutating files or the platform.
|
|
1065
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1066
|
+
the resource's own; `--json` is unaffected.
|
|
1067
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1068
|
+
--no-telemetry.
|
|
1069
|
+
--verbose Verbose logging.
|
|
1116
1070
|
|
|
1117
1071
|
GLOBAL FLAGS
|
|
1118
1072
|
--json Format output as json.
|
|
@@ -1135,7 +1089,7 @@ USAGE
|
|
|
1135
1089
|
$ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
|
|
1136
1090
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
1137
1091
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1138
|
-
[--sort <value>]
|
|
1092
|
+
[--sort <value>]
|
|
1139
1093
|
|
|
1140
1094
|
FLAGS
|
|
1141
1095
|
-a, --all
|
|
@@ -1144,10 +1098,6 @@ FLAGS
|
|
|
1144
1098
|
-c, --cwd=<value>
|
|
1145
1099
|
Project directory to operate on.
|
|
1146
1100
|
|
|
1147
|
-
-e, --environment=<option>
|
|
1148
|
-
Target environment (default: development).
|
|
1149
|
-
<options: development|preview|production>
|
|
1150
|
-
|
|
1151
1101
|
-n, --non-interactive
|
|
1152
1102
|
Disable prompts. Required when scripting or running as an agent.
|
|
1153
1103
|
|
|
@@ -1239,21 +1189,18 @@ Validate config without mutation and preview the sync diff.
|
|
|
1239
1189
|
```
|
|
1240
1190
|
USAGE
|
|
1241
1191
|
$ zitadel plan [--json] [-c <value>] [-s <value>] [-n]
|
|
1242
|
-
[--dry-run] [--verbose] [--debug] [--telemetry]
|
|
1243
|
-
development|preview|production]
|
|
1192
|
+
[--dry-run] [--verbose] [--debug] [--telemetry]
|
|
1244
1193
|
|
|
1245
1194
|
FLAGS
|
|
1246
|
-
-c, --cwd=<value>
|
|
1247
|
-
-
|
|
1248
|
-
|
|
1249
|
-
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
--
|
|
1253
|
-
|
|
1254
|
-
--
|
|
1255
|
-
--no-telemetry.
|
|
1256
|
-
--verbose Verbose logging.
|
|
1195
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1196
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1197
|
+
an agent.
|
|
1198
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1199
|
+
--debug Debug logging.
|
|
1200
|
+
--dry-run Preview without mutating files or the platform.
|
|
1201
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1202
|
+
--no-telemetry.
|
|
1203
|
+
--verbose Verbose logging.
|
|
1257
1204
|
|
|
1258
1205
|
GLOBAL FLAGS
|
|
1259
1206
|
--json Format output as json.
|
|
@@ -1269,27 +1216,23 @@ Get one project by id.
|
|
|
1269
1216
|
```
|
|
1270
1217
|
USAGE
|
|
1271
1218
|
$ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1272
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1273
|
-
development|preview|production]
|
|
1219
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1274
1220
|
|
|
1275
1221
|
ARGUMENTS
|
|
1276
1222
|
ID project id
|
|
1277
1223
|
|
|
1278
1224
|
FLAGS
|
|
1279
|
-
-c, --cwd=<value>
|
|
1280
|
-
-
|
|
1281
|
-
|
|
1282
|
-
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1285
|
-
--
|
|
1286
|
-
|
|
1287
|
-
--
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1291
|
-
--no-telemetry.
|
|
1292
|
-
--verbose Verbose logging.
|
|
1225
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1226
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1227
|
+
an agent.
|
|
1228
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1229
|
+
--debug Debug logging.
|
|
1230
|
+
--dry-run Preview without mutating files or the platform.
|
|
1231
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1232
|
+
the resource's own; `--json` is unaffected.
|
|
1233
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1234
|
+
--no-telemetry.
|
|
1235
|
+
--verbose Verbose logging.
|
|
1293
1236
|
|
|
1294
1237
|
GLOBAL FLAGS
|
|
1295
1238
|
--json Format output as json.
|
|
@@ -1312,34 +1255,32 @@ USAGE
|
|
|
1312
1255
|
$ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
|
|
1313
1256
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
1314
1257
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1315
|
-
[--sort <value>]
|
|
1258
|
+
[--sort <value>]
|
|
1316
1259
|
|
|
1317
1260
|
FLAGS
|
|
1318
|
-
-a, --all
|
|
1319
|
-
-c, --cwd=<value>
|
|
1320
|
-
-
|
|
1321
|
-
|
|
1322
|
-
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
--
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
--
|
|
1335
|
-
|
|
1336
|
-
--
|
|
1337
|
-
|
|
1338
|
-
--
|
|
1339
|
-
|
|
1340
|
-
--
|
|
1341
|
-
--no-telemetry.
|
|
1342
|
-
--verbose Verbose logging.
|
|
1261
|
+
-a, --all Fetch every page instead of one.
|
|
1262
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1263
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1264
|
+
as an agent.
|
|
1265
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1266
|
+
--debug Debug logging.
|
|
1267
|
+
--dry-run Preview without mutating files or the platform.
|
|
1268
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1269
|
+
id,attributes.email). Defaults to the resource's own
|
|
1270
|
+
columns; `--json` is unaffected.
|
|
1271
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
1272
|
+
to equals). Fields: created_at (equals|not_equals|co
|
|
1273
|
+
ntains|not_contains|less_than|less_than_or_equal|gre
|
|
1274
|
+
ater_than|greater_than_or_equal).
|
|
1275
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1276
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1277
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1278
|
+
Implied when stdout is not a terminal.
|
|
1279
|
+
--sort=<value> Sort as field:direction (asc|desc). Fields:
|
|
1280
|
+
created_at.
|
|
1281
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1282
|
+
--no-telemetry.
|
|
1283
|
+
--verbose Verbose logging.
|
|
1343
1284
|
|
|
1344
1285
|
GLOBAL FLAGS
|
|
1345
1286
|
--json Format output as json.
|
|
@@ -1363,23 +1304,21 @@ Update a project by id.
|
|
|
1363
1304
|
USAGE
|
|
1364
1305
|
$ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1365
1306
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
|
|
1366
|
-
<value> | --file <value>]
|
|
1307
|
+
<value> | --file <value>]
|
|
1367
1308
|
|
|
1368
1309
|
ARGUMENTS
|
|
1369
1310
|
ID project id
|
|
1370
1311
|
|
|
1371
1312
|
FLAGS
|
|
1372
|
-
-c, --cwd=<value>
|
|
1373
|
-
-
|
|
1374
|
-
|
|
1375
|
-
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
--
|
|
1379
|
-
|
|
1380
|
-
--
|
|
1381
|
-
--no-telemetry.
|
|
1382
|
-
--verbose Verbose logging.
|
|
1313
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1314
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1315
|
+
an agent.
|
|
1316
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1317
|
+
--debug Debug logging.
|
|
1318
|
+
--dry-run Preview without mutating files or the platform.
|
|
1319
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1320
|
+
--no-telemetry.
|
|
1321
|
+
--verbose Verbose logging.
|
|
1383
1322
|
|
|
1384
1323
|
RAW BODY FLAGS
|
|
1385
1324
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -1407,27 +1346,23 @@ Get one release by id.
|
|
|
1407
1346
|
```
|
|
1408
1347
|
USAGE
|
|
1409
1348
|
$ zitadel releases get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1410
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1411
|
-
development|preview|production]
|
|
1349
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1412
1350
|
|
|
1413
1351
|
ARGUMENTS
|
|
1414
1352
|
ID release id
|
|
1415
1353
|
|
|
1416
1354
|
FLAGS
|
|
1417
|
-
-c, --cwd=<value>
|
|
1418
|
-
-
|
|
1419
|
-
|
|
1420
|
-
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
--
|
|
1424
|
-
|
|
1425
|
-
--
|
|
1426
|
-
|
|
1427
|
-
|
|
1428
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1429
|
-
--no-telemetry.
|
|
1430
|
-
--verbose Verbose logging.
|
|
1355
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1356
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1357
|
+
an agent.
|
|
1358
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1359
|
+
--debug Debug logging.
|
|
1360
|
+
--dry-run Preview without mutating files or the platform.
|
|
1361
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1362
|
+
the resource's own; `--json` is unaffected.
|
|
1363
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1364
|
+
--no-telemetry.
|
|
1365
|
+
--verbose Verbose logging.
|
|
1431
1366
|
|
|
1432
1367
|
GLOBAL FLAGS
|
|
1433
1368
|
--json Format output as json.
|
|
@@ -1449,29 +1384,26 @@ List releases.
|
|
|
1449
1384
|
USAGE
|
|
1450
1385
|
$ zitadel releases list [--json] [-c <value>] [-s <value>] [-n]
|
|
1451
1386
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
1452
|
-
--page-token <value>] [--fields <value>] [--plain]
|
|
1453
|
-
development|preview|production]
|
|
1387
|
+
--page-token <value>] [--fields <value>] [--plain]
|
|
1454
1388
|
|
|
1455
1389
|
FLAGS
|
|
1456
|
-
-a, --all
|
|
1457
|
-
-c, --cwd=<value>
|
|
1458
|
-
-
|
|
1459
|
-
|
|
1460
|
-
-
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
--
|
|
1464
|
-
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
--
|
|
1469
|
-
|
|
1470
|
-
--
|
|
1471
|
-
|
|
1472
|
-
--
|
|
1473
|
-
--no-telemetry.
|
|
1474
|
-
--verbose Verbose logging.
|
|
1390
|
+
-a, --all Fetch every page instead of one.
|
|
1391
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1392
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1393
|
+
as an agent.
|
|
1394
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1395
|
+
--debug Debug logging.
|
|
1396
|
+
--dry-run Preview without mutating files or the platform.
|
|
1397
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1398
|
+
id,attributes.email). Defaults to the resource's own
|
|
1399
|
+
columns; `--json` is unaffected.
|
|
1400
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1401
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1402
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1403
|
+
Implied when stdout is not a terminal.
|
|
1404
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1405
|
+
--no-telemetry.
|
|
1406
|
+
--verbose Verbose logging.
|
|
1475
1407
|
|
|
1476
1408
|
GLOBAL FLAGS
|
|
1477
1409
|
--json Format output as json.
|
|
@@ -1555,27 +1487,23 @@ Get one schema by id.
|
|
|
1555
1487
|
```
|
|
1556
1488
|
USAGE
|
|
1557
1489
|
$ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
|
|
1558
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1559
|
-
development|preview|production]
|
|
1490
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1560
1491
|
|
|
1561
1492
|
ARGUMENTS
|
|
1562
1493
|
SCHEMA object type (current revision) or revision id
|
|
1563
1494
|
|
|
1564
1495
|
FLAGS
|
|
1565
|
-
-c, --cwd=<value>
|
|
1566
|
-
-
|
|
1567
|
-
|
|
1568
|
-
-
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
--
|
|
1572
|
-
|
|
1573
|
-
--
|
|
1574
|
-
|
|
1575
|
-
|
|
1576
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1577
|
-
--no-telemetry.
|
|
1578
|
-
--verbose Verbose logging.
|
|
1496
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1497
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1498
|
+
an agent.
|
|
1499
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1500
|
+
--debug Debug logging.
|
|
1501
|
+
--dry-run Preview without mutating files or the platform.
|
|
1502
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1503
|
+
the resource's own; `--json` is unaffected.
|
|
1504
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1505
|
+
--no-telemetry.
|
|
1506
|
+
--verbose Verbose logging.
|
|
1579
1507
|
|
|
1580
1508
|
GLOBAL FLAGS
|
|
1581
1509
|
--json Format output as json.
|
|
@@ -1597,33 +1525,29 @@ List schemas.
|
|
|
1597
1525
|
USAGE
|
|
1598
1526
|
$ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
|
|
1599
1527
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
1600
|
-
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1601
|
-
development|preview|production]
|
|
1528
|
+
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1602
1529
|
|
|
1603
1530
|
FLAGS
|
|
1604
|
-
-a, --all
|
|
1605
|
-
-c, --cwd=<value>
|
|
1606
|
-
-
|
|
1607
|
-
|
|
1608
|
-
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
--
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
--
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1625
|
-
--no-telemetry.
|
|
1626
|
-
--verbose Verbose logging.
|
|
1531
|
+
-a, --all Fetch every page instead of one.
|
|
1532
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1533
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1534
|
+
as an agent.
|
|
1535
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1536
|
+
--debug Debug logging.
|
|
1537
|
+
--dry-run Preview without mutating files or the platform.
|
|
1538
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1539
|
+
id,attributes.email). Defaults to the resource's own
|
|
1540
|
+
columns; `--json` is unaffected.
|
|
1541
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
1542
|
+
to equals). Fields: object_type (equals), kind
|
|
1543
|
+
(equals), revisions (equals; values all|latest).
|
|
1544
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1545
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1546
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1547
|
+
Implied when stdout is not a terminal.
|
|
1548
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1549
|
+
--no-telemetry.
|
|
1550
|
+
--verbose Verbose logging.
|
|
1627
1551
|
|
|
1628
1552
|
GLOBAL FLAGS
|
|
1629
1553
|
--json Format output as json.
|
|
@@ -1663,27 +1587,23 @@ Get one session by id.
|
|
|
1663
1587
|
```
|
|
1664
1588
|
USAGE
|
|
1665
1589
|
$ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1666
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1667
|
-
development|preview|production]
|
|
1590
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
1668
1591
|
|
|
1669
1592
|
ARGUMENTS
|
|
1670
1593
|
ID session id
|
|
1671
1594
|
|
|
1672
1595
|
FLAGS
|
|
1673
|
-
-c, --cwd=<value>
|
|
1674
|
-
-
|
|
1675
|
-
|
|
1676
|
-
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
--
|
|
1680
|
-
|
|
1681
|
-
--
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1685
|
-
--no-telemetry.
|
|
1686
|
-
--verbose Verbose logging.
|
|
1596
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1597
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1598
|
+
an agent.
|
|
1599
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1600
|
+
--debug Debug logging.
|
|
1601
|
+
--dry-run Preview without mutating files or the platform.
|
|
1602
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1603
|
+
the resource's own; `--json` is unaffected.
|
|
1604
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1605
|
+
--no-telemetry.
|
|
1606
|
+
--verbose Verbose logging.
|
|
1687
1607
|
|
|
1688
1608
|
GLOBAL FLAGS
|
|
1689
1609
|
--json Format output as json.
|
|
@@ -1706,7 +1626,7 @@ USAGE
|
|
|
1706
1626
|
$ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
|
|
1707
1627
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
1708
1628
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
1709
|
-
[--sort <value>]
|
|
1629
|
+
[--sort <value>]
|
|
1710
1630
|
|
|
1711
1631
|
FLAGS
|
|
1712
1632
|
-a, --all
|
|
@@ -1715,10 +1635,6 @@ FLAGS
|
|
|
1715
1635
|
-c, --cwd=<value>
|
|
1716
1636
|
Project directory to operate on.
|
|
1717
1637
|
|
|
1718
|
-
-e, --environment=<option>
|
|
1719
|
-
Target environment (default: development).
|
|
1720
|
-
<options: development|preview|production>
|
|
1721
|
-
|
|
1722
1638
|
-n, --non-interactive
|
|
1723
1639
|
Disable prompts. Required when scripting or running as an agent.
|
|
1724
1640
|
|
|
@@ -1785,26 +1701,23 @@ Revoke a session by id.
|
|
|
1785
1701
|
```
|
|
1786
1702
|
USAGE
|
|
1787
1703
|
$ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1788
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
1789
|
-
development|preview|production]
|
|
1704
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
1790
1705
|
|
|
1791
1706
|
ARGUMENTS
|
|
1792
1707
|
ID session id
|
|
1793
1708
|
|
|
1794
1709
|
FLAGS
|
|
1795
|
-
-c, --cwd=<value>
|
|
1796
|
-
-
|
|
1797
|
-
|
|
1798
|
-
-
|
|
1799
|
-
|
|
1800
|
-
-
|
|
1801
|
-
|
|
1802
|
-
|
|
1803
|
-
--
|
|
1804
|
-
|
|
1805
|
-
--
|
|
1806
|
-
--no-telemetry.
|
|
1807
|
-
--verbose Verbose logging.
|
|
1710
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1711
|
+
-f, --force Revoke the session without the confirmation prompt.
|
|
1712
|
+
Required when non-interactive.
|
|
1713
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1714
|
+
an agent.
|
|
1715
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1716
|
+
--debug Debug logging.
|
|
1717
|
+
--dry-run Preview without mutating files or the platform.
|
|
1718
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1719
|
+
--no-telemetry.
|
|
1720
|
+
--verbose Verbose logging.
|
|
1808
1721
|
|
|
1809
1722
|
GLOBAL FLAGS
|
|
1810
1723
|
--json Format output as json.
|
|
@@ -1827,7 +1740,6 @@ USAGE
|
|
|
1827
1740
|
next|nuxt|react|vue|solid|svelte|qwik|angular] [--renderer react]
|
|
1828
1741
|
[--dev-port <value>] [--skip-install] [--preset
|
|
1829
1742
|
password-first|passkey-first] [--use-case minimal|consumer|business]
|
|
1830
|
-
[--design centered|split|split-right|hero|minimal]
|
|
1831
1743
|
|
|
1832
1744
|
FLAGS
|
|
1833
1745
|
-c, --cwd=<value>
|
|
@@ -1845,17 +1757,6 @@ FLAGS
|
|
|
1845
1757
|
--debug
|
|
1846
1758
|
Debug logging.
|
|
1847
1759
|
|
|
1848
|
-
--design=<option>
|
|
1849
|
-
Login design to eject into .zitadel/branding/ and publish as branding
|
|
1850
|
-
revision 1. Skips the wizard's design question. When omitted in
|
|
1851
|
-
non-interactive runs, the login uses the built-in template; run the
|
|
1852
|
-
`branding eject` command later to customize. Split-family designs (split,
|
|
1853
|
-
split-right, hero) collapse their brand pane by container width: narrow
|
|
1854
|
-
containers — including widget-posture embeds at card width — render the
|
|
1855
|
-
compact brand mark instead (logo_url, else hero_url, from
|
|
1856
|
-
.zitadel/branding/branding.json; hero falls back to editable text).
|
|
1857
|
-
<options: centered|split|split-right|hero|minimal>
|
|
1858
|
-
|
|
1859
1760
|
--dev-port=<value>
|
|
1860
1761
|
Dev-server port; also the issuer origin registered with Zitadel. Defaults to
|
|
1861
1762
|
the detected port. Use distinct ports to run several scaffolded apps side by
|
|
@@ -1999,20 +1900,18 @@ Create a team.
|
|
|
1999
1900
|
USAGE
|
|
2000
1901
|
$ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
|
|
2001
1902
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
|
|
2002
|
-
<value> | --file <value>]
|
|
1903
|
+
<value> | --file <value>]
|
|
2003
1904
|
|
|
2004
1905
|
FLAGS
|
|
2005
|
-
-c, --cwd=<value>
|
|
2006
|
-
-
|
|
2007
|
-
|
|
2008
|
-
-
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
--
|
|
2012
|
-
|
|
2013
|
-
--
|
|
2014
|
-
--no-telemetry.
|
|
2015
|
-
--verbose Verbose logging.
|
|
1906
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1907
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1908
|
+
an agent.
|
|
1909
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1910
|
+
--debug Debug logging.
|
|
1911
|
+
--dry-run Preview without mutating files or the platform.
|
|
1912
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1913
|
+
--no-telemetry.
|
|
1914
|
+
--verbose Verbose logging.
|
|
2016
1915
|
|
|
2017
1916
|
RAW BODY FLAGS
|
|
2018
1917
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -2042,26 +1941,23 @@ Deactivate a team by id.
|
|
|
2042
1941
|
```
|
|
2043
1942
|
USAGE
|
|
2044
1943
|
$ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2045
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
2046
|
-
development|preview|production]
|
|
1944
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
2047
1945
|
|
|
2048
1946
|
ARGUMENTS
|
|
2049
1947
|
ID team id
|
|
2050
1948
|
|
|
2051
1949
|
FLAGS
|
|
2052
|
-
-c, --cwd=<value>
|
|
2053
|
-
-
|
|
2054
|
-
|
|
2055
|
-
-
|
|
2056
|
-
|
|
2057
|
-
-
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
--
|
|
2061
|
-
|
|
2062
|
-
--
|
|
2063
|
-
--no-telemetry.
|
|
2064
|
-
--verbose Verbose logging.
|
|
1950
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1951
|
+
-f, --force Deactivate the team without the confirmation prompt.
|
|
1952
|
+
Required when non-interactive.
|
|
1953
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1954
|
+
an agent.
|
|
1955
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1956
|
+
--debug Debug logging.
|
|
1957
|
+
--dry-run Preview without mutating files or the platform.
|
|
1958
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1959
|
+
--no-telemetry.
|
|
1960
|
+
--verbose Verbose logging.
|
|
2065
1961
|
|
|
2066
1962
|
GLOBAL FLAGS
|
|
2067
1963
|
--json Format output as json.
|
|
@@ -2080,27 +1976,23 @@ Get one team by id.
|
|
|
2080
1976
|
```
|
|
2081
1977
|
USAGE
|
|
2082
1978
|
$ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2083
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
2084
|
-
development|preview|production]
|
|
1979
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
2085
1980
|
|
|
2086
1981
|
ARGUMENTS
|
|
2087
1982
|
ID team id
|
|
2088
1983
|
|
|
2089
1984
|
FLAGS
|
|
2090
|
-
-c, --cwd=<value>
|
|
2091
|
-
-
|
|
2092
|
-
|
|
2093
|
-
-
|
|
2094
|
-
|
|
2095
|
-
|
|
2096
|
-
--
|
|
2097
|
-
|
|
2098
|
-
--
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2102
|
-
--no-telemetry.
|
|
2103
|
-
--verbose Verbose logging.
|
|
1985
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1986
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1987
|
+
an agent.
|
|
1988
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1989
|
+
--debug Debug logging.
|
|
1990
|
+
--dry-run Preview without mutating files or the platform.
|
|
1991
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1992
|
+
the resource's own; `--json` is unaffected.
|
|
1993
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1994
|
+
--no-telemetry.
|
|
1995
|
+
--verbose Verbose logging.
|
|
2104
1996
|
|
|
2105
1997
|
GLOBAL FLAGS
|
|
2106
1998
|
--json Format output as json.
|
|
@@ -2123,7 +2015,7 @@ USAGE
|
|
|
2123
2015
|
$ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
|
|
2124
2016
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
2125
2017
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
2126
|
-
[--sort <value>]
|
|
2018
|
+
[--sort <value>]
|
|
2127
2019
|
|
|
2128
2020
|
FLAGS
|
|
2129
2021
|
-a, --all
|
|
@@ -2132,10 +2024,6 @@ FLAGS
|
|
|
2132
2024
|
-c, --cwd=<value>
|
|
2133
2025
|
Project directory to operate on.
|
|
2134
2026
|
|
|
2135
|
-
-e, --environment=<option>
|
|
2136
|
-
Target environment (default: development).
|
|
2137
|
-
<options: development|preview|production>
|
|
2138
|
-
|
|
2139
2027
|
-n, --non-interactive
|
|
2140
2028
|
Disable prompts. Required when scripting or running as an agent.
|
|
2141
2029
|
|
|
@@ -2201,23 +2089,21 @@ Update a team by id.
|
|
|
2201
2089
|
USAGE
|
|
2202
2090
|
$ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2203
2091
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--name <value>] [--data
|
|
2204
|
-
<value> | --file <value>]
|
|
2092
|
+
<value> | --file <value>]
|
|
2205
2093
|
|
|
2206
2094
|
ARGUMENTS
|
|
2207
2095
|
ID team id
|
|
2208
2096
|
|
|
2209
2097
|
FLAGS
|
|
2210
|
-
-c, --cwd=<value>
|
|
2211
|
-
-
|
|
2212
|
-
|
|
2213
|
-
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
--
|
|
2217
|
-
|
|
2218
|
-
--
|
|
2219
|
-
--no-telemetry.
|
|
2220
|
-
--verbose Verbose logging.
|
|
2098
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2099
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2100
|
+
an agent.
|
|
2101
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2102
|
+
--debug Debug logging.
|
|
2103
|
+
--dry-run Preview without mutating files or the platform.
|
|
2104
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2105
|
+
--no-telemetry.
|
|
2106
|
+
--verbose Verbose logging.
|
|
2221
2107
|
|
|
2222
2108
|
RAW BODY FLAGS
|
|
2223
2109
|
--data=<value> Whole body as a JSON object, instead of the field flags.
|
|
@@ -2278,21 +2164,18 @@ Create an user.
|
|
|
2278
2164
|
USAGE
|
|
2279
2165
|
$ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
|
|
2280
2166
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--schema <value>]
|
|
2281
|
-
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2282
|
-
development|preview|production]
|
|
2167
|
+
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2283
2168
|
|
|
2284
2169
|
FLAGS
|
|
2285
|
-
-c, --cwd=<value>
|
|
2286
|
-
-
|
|
2287
|
-
|
|
2288
|
-
-
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
--
|
|
2292
|
-
|
|
2293
|
-
--
|
|
2294
|
-
--no-telemetry.
|
|
2295
|
-
--verbose Verbose logging.
|
|
2170
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2171
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2172
|
+
an agent.
|
|
2173
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2174
|
+
--debug Debug logging.
|
|
2175
|
+
--dry-run Preview without mutating files or the platform.
|
|
2176
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2177
|
+
--no-telemetry.
|
|
2178
|
+
--verbose Verbose logging.
|
|
2296
2179
|
|
|
2297
2180
|
REQUIRED FIELD FLAGS
|
|
2298
2181
|
--attributes=<value>... (required) Repeatable attributes entry: key=value for
|
|
@@ -2326,26 +2209,23 @@ Delete an user by id.
|
|
|
2326
2209
|
```
|
|
2327
2210
|
USAGE
|
|
2328
2211
|
$ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2329
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
2330
|
-
development|preview|production]
|
|
2212
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [-f]
|
|
2331
2213
|
|
|
2332
2214
|
ARGUMENTS
|
|
2333
2215
|
ID user id
|
|
2334
2216
|
|
|
2335
2217
|
FLAGS
|
|
2336
|
-
-c, --cwd=<value>
|
|
2337
|
-
-
|
|
2338
|
-
|
|
2339
|
-
-
|
|
2340
|
-
|
|
2341
|
-
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
--
|
|
2345
|
-
|
|
2346
|
-
--
|
|
2347
|
-
--no-telemetry.
|
|
2348
|
-
--verbose Verbose logging.
|
|
2218
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2219
|
+
-f, --force Delete the user without the confirmation prompt.
|
|
2220
|
+
Required when non-interactive.
|
|
2221
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2222
|
+
an agent.
|
|
2223
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2224
|
+
--debug Debug logging.
|
|
2225
|
+
--dry-run Preview without mutating files or the platform.
|
|
2226
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2227
|
+
--no-telemetry.
|
|
2228
|
+
--verbose Verbose logging.
|
|
2349
2229
|
|
|
2350
2230
|
GLOBAL FLAGS
|
|
2351
2231
|
--json Format output as json.
|
|
@@ -2364,27 +2244,23 @@ Get one user by id.
|
|
|
2364
2244
|
```
|
|
2365
2245
|
USAGE
|
|
2366
2246
|
$ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2367
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
2368
|
-
development|preview|production]
|
|
2247
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--fields <value>]
|
|
2369
2248
|
|
|
2370
2249
|
ARGUMENTS
|
|
2371
2250
|
ID user id
|
|
2372
2251
|
|
|
2373
2252
|
FLAGS
|
|
2374
|
-
-c, --cwd=<value>
|
|
2375
|
-
-
|
|
2376
|
-
|
|
2377
|
-
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
--
|
|
2381
|
-
|
|
2382
|
-
--
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2386
|
-
--no-telemetry.
|
|
2387
|
-
--verbose Verbose logging.
|
|
2253
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2254
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2255
|
+
an agent.
|
|
2256
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2257
|
+
--debug Debug logging.
|
|
2258
|
+
--dry-run Preview without mutating files or the platform.
|
|
2259
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2260
|
+
the resource's own; `--json` is unaffected.
|
|
2261
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2262
|
+
--no-telemetry.
|
|
2263
|
+
--verbose Verbose logging.
|
|
2388
2264
|
|
|
2389
2265
|
GLOBAL FLAGS
|
|
2390
2266
|
--json Format output as json.
|
|
@@ -2407,7 +2283,7 @@ USAGE
|
|
|
2407
2283
|
$ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
|
|
2408
2284
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--limit <value>] [-a |
|
|
2409
2285
|
--page-token <value>] [--fields <value>] [--plain] [--filter <value>...]
|
|
2410
|
-
[--sort <value>]
|
|
2286
|
+
[--sort <value>]
|
|
2411
2287
|
|
|
2412
2288
|
FLAGS
|
|
2413
2289
|
-a, --all
|
|
@@ -2416,10 +2292,6 @@ FLAGS
|
|
|
2416
2292
|
-c, --cwd=<value>
|
|
2417
2293
|
Project directory to operate on.
|
|
2418
2294
|
|
|
2419
|
-
-e, --environment=<option>
|
|
2420
|
-
Target environment (default: development).
|
|
2421
|
-
<options: development|preview|production>
|
|
2422
|
-
|
|
2423
2295
|
-n, --non-interactive
|
|
2424
2296
|
Disable prompts. Required when scripting or running as an agent.
|
|
2425
2297
|
|
|
@@ -2491,24 +2363,21 @@ Update an user by id.
|
|
|
2491
2363
|
USAGE
|
|
2492
2364
|
$ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2493
2365
|
[--dry-run] [--verbose] [--debug] [--telemetry] [--schema <value>]
|
|
2494
|
-
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2495
|
-
development|preview|production]
|
|
2366
|
+
[--attributes <value>...] [--data <value> | --file <value>]
|
|
2496
2367
|
|
|
2497
2368
|
ARGUMENTS
|
|
2498
2369
|
ID user id
|
|
2499
2370
|
|
|
2500
2371
|
FLAGS
|
|
2501
|
-
-c, --cwd=<value>
|
|
2502
|
-
-
|
|
2503
|
-
|
|
2504
|
-
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
--
|
|
2508
|
-
|
|
2509
|
-
--
|
|
2510
|
-
--no-telemetry.
|
|
2511
|
-
--verbose Verbose logging.
|
|
2372
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2373
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2374
|
+
an agent.
|
|
2375
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2376
|
+
--debug Debug logging.
|
|
2377
|
+
--dry-run Preview without mutating files or the platform.
|
|
2378
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2379
|
+
--no-telemetry.
|
|
2380
|
+
--verbose Verbose logging.
|
|
2512
2381
|
|
|
2513
2382
|
OPTIONAL FIELD FLAGS
|
|
2514
2383
|
--attributes=<value>... Repeatable attributes entry: key=value for a string,
|
|
@@ -2533,169 +2402,158 @@ EXAMPLES
|
|
|
2533
2402
|
|
|
2534
2403
|
## `zitadel variables delete NAME`
|
|
2535
2404
|
|
|
2536
|
-
Delete one variable from
|
|
2405
|
+
Delete one variable from the project.
|
|
2537
2406
|
|
|
2538
2407
|
```
|
|
2539
2408
|
USAGE
|
|
2540
2409
|
$ zitadel variables delete NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2541
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-
|
|
2542
|
-
--project-level] [-f]
|
|
2410
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--project-level] [-f]
|
|
2543
2411
|
|
|
2544
2412
|
ARGUMENTS
|
|
2545
2413
|
NAME Variable name to delete.
|
|
2546
2414
|
|
|
2547
2415
|
FLAGS
|
|
2548
|
-
-c, --cwd=<value>
|
|
2549
|
-
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
--
|
|
2556
|
-
--
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
--
|
|
2561
|
-
--no-telemetry.
|
|
2562
|
-
--verbose Verbose logging.
|
|
2416
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2417
|
+
-f, --force Delete the variable without the confirmation prompt.
|
|
2418
|
+
Required when non-interactive.
|
|
2419
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2420
|
+
an agent.
|
|
2421
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2422
|
+
--debug Debug logging.
|
|
2423
|
+
--dry-run Preview without mutating files or the platform.
|
|
2424
|
+
--project-level Address the project level. Required: it is the only
|
|
2425
|
+
owner the CLI can address today.
|
|
2426
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2427
|
+
--no-telemetry.
|
|
2428
|
+
--verbose Verbose logging.
|
|
2563
2429
|
|
|
2564
2430
|
GLOBAL FLAGS
|
|
2565
2431
|
--json Format output as json.
|
|
2566
2432
|
|
|
2567
2433
|
DESCRIPTION
|
|
2568
|
-
Delete one variable from
|
|
2434
|
+
Delete one variable from the project.
|
|
2569
2435
|
|
|
2570
2436
|
EXAMPLES
|
|
2571
|
-
$ zitadel variables delete GOOGLE_CLIENT_ID --
|
|
2437
|
+
$ zitadel variables delete GOOGLE_CLIENT_ID --project-level
|
|
2572
2438
|
|
|
2573
2439
|
$ zitadel variables delete GOOGLE_CLIENT_ID --project-level --force
|
|
2574
2440
|
```
|
|
2575
2441
|
|
|
2576
2442
|
## `zitadel variables get NAME`
|
|
2577
2443
|
|
|
2578
|
-
Get one variable from
|
|
2444
|
+
Get one variable from the project.
|
|
2579
2445
|
|
|
2580
2446
|
```
|
|
2581
2447
|
USAGE
|
|
2582
2448
|
$ zitadel variables get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2583
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-
|
|
2584
|
-
--project-level]
|
|
2449
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--project-level]
|
|
2585
2450
|
|
|
2586
2451
|
ARGUMENTS
|
|
2587
2452
|
NAME Variable name to read.
|
|
2588
2453
|
|
|
2589
2454
|
FLAGS
|
|
2590
|
-
-c, --cwd=<value>
|
|
2591
|
-
-
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
|
|
2595
|
-
--
|
|
2596
|
-
--
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
--
|
|
2601
|
-
--no-telemetry.
|
|
2602
|
-
--verbose Verbose logging.
|
|
2455
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2456
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2457
|
+
an agent.
|
|
2458
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2459
|
+
--debug Debug logging.
|
|
2460
|
+
--dry-run Preview without mutating files or the platform.
|
|
2461
|
+
--project-level Address the project level. Required: it is the only
|
|
2462
|
+
owner the CLI can address today.
|
|
2463
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2464
|
+
--no-telemetry.
|
|
2465
|
+
--verbose Verbose logging.
|
|
2603
2466
|
|
|
2604
2467
|
GLOBAL FLAGS
|
|
2605
2468
|
--json Format output as json.
|
|
2606
2469
|
|
|
2607
2470
|
DESCRIPTION
|
|
2608
|
-
Get one variable from
|
|
2471
|
+
Get one variable from the project.
|
|
2609
2472
|
|
|
2610
2473
|
EXAMPLES
|
|
2611
|
-
$ zitadel variables get GOOGLE_CLIENT_ID --
|
|
2474
|
+
$ zitadel variables get GOOGLE_CLIENT_ID --project-level
|
|
2612
2475
|
|
|
2613
|
-
$ zitadel variables get GOOGLE_CLIENT_ID --
|
|
2476
|
+
$ zitadel variables get GOOGLE_CLIENT_ID --project-level --json
|
|
2614
2477
|
```
|
|
2615
2478
|
|
|
2616
2479
|
## `zitadel variables list`
|
|
2617
2480
|
|
|
2618
|
-
List the variables entered on
|
|
2481
|
+
List the variables entered on the project.
|
|
2619
2482
|
|
|
2620
2483
|
```
|
|
2621
2484
|
USAGE
|
|
2622
2485
|
$ zitadel variables list [--json] [-c <value>] [-s <value>] [-n]
|
|
2623
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-
|
|
2624
|
-
--project-level] [--plain]
|
|
2486
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--project-level] [--plain]
|
|
2625
2487
|
|
|
2626
2488
|
FLAGS
|
|
2627
|
-
-c, --cwd=<value>
|
|
2628
|
-
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
--
|
|
2633
|
-
--
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
|
|
2638
|
-
|
|
2639
|
-
--
|
|
2640
|
-
--no-telemetry.
|
|
2641
|
-
--verbose Verbose logging.
|
|
2489
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2490
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2491
|
+
an agent.
|
|
2492
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2493
|
+
--debug Debug logging.
|
|
2494
|
+
--dry-run Preview without mutating files or the platform.
|
|
2495
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
2496
|
+
when stdout is not a terminal.
|
|
2497
|
+
--project-level Address the project level. Required: it is the only
|
|
2498
|
+
owner the CLI can address today.
|
|
2499
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2500
|
+
--no-telemetry.
|
|
2501
|
+
--verbose Verbose logging.
|
|
2642
2502
|
|
|
2643
2503
|
GLOBAL FLAGS
|
|
2644
2504
|
--json Format output as json.
|
|
2645
2505
|
|
|
2646
2506
|
DESCRIPTION
|
|
2647
|
-
List the variables entered on
|
|
2507
|
+
List the variables entered on the project.
|
|
2648
2508
|
|
|
2649
2509
|
EXAMPLES
|
|
2650
|
-
$ zitadel variables list --
|
|
2510
|
+
$ zitadel variables list --project-level
|
|
2651
2511
|
|
|
2652
2512
|
$ zitadel variables list --project-level --json
|
|
2653
2513
|
```
|
|
2654
2514
|
|
|
2655
2515
|
## `zitadel variables set NAME`
|
|
2656
2516
|
|
|
2657
|
-
Set one variable on
|
|
2517
|
+
Set one variable on the project.
|
|
2658
2518
|
|
|
2659
2519
|
```
|
|
2660
2520
|
USAGE
|
|
2661
2521
|
$ zitadel variables set NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
2662
|
-
[--dry-run] [--verbose] [--debug] [--telemetry] [-
|
|
2663
|
-
|
|
2522
|
+
[--dry-run] [--verbose] [--debug] [--telemetry] [--project-level] [--secret]
|
|
2523
|
+
[--as string|number|boolean]
|
|
2664
2524
|
|
|
2665
2525
|
ARGUMENTS
|
|
2666
2526
|
NAME Variable name (letters, digits and underscores).
|
|
2667
2527
|
|
|
2668
2528
|
FLAGS
|
|
2669
|
-
-c, --cwd=<value>
|
|
2670
|
-
-
|
|
2671
|
-
|
|
2672
|
-
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
|
-
|
|
2678
|
-
--
|
|
2679
|
-
--
|
|
2680
|
-
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
--
|
|
2684
|
-
|
|
2685
|
-
--
|
|
2686
|
-
--no-telemetry.
|
|
2687
|
-
--verbose Verbose logging.
|
|
2529
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2530
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2531
|
+
an agent.
|
|
2532
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2533
|
+
--as=<option> [default: string] Store the value as this JSON type. A
|
|
2534
|
+
reference to the whole field resolves to that type, so
|
|
2535
|
+
a number stays a number.
|
|
2536
|
+
<options: string|number|boolean>
|
|
2537
|
+
--debug Debug logging.
|
|
2538
|
+
--dry-run Preview without mutating files or the platform.
|
|
2539
|
+
--project-level Address the project level. Required: it is the only
|
|
2540
|
+
owner the CLI can address today.
|
|
2541
|
+
--secret Store the value encrypted. It can be replaced later but
|
|
2542
|
+
never read back.
|
|
2543
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2544
|
+
--no-telemetry.
|
|
2545
|
+
--verbose Verbose logging.
|
|
2688
2546
|
|
|
2689
2547
|
GLOBAL FLAGS
|
|
2690
2548
|
--json Format output as json.
|
|
2691
2549
|
|
|
2692
2550
|
DESCRIPTION
|
|
2693
|
-
Set one variable on
|
|
2551
|
+
Set one variable on the project.
|
|
2694
2552
|
|
|
2695
2553
|
EXAMPLES
|
|
2696
|
-
$ zitadel variables set GOOGLE_CLIENT_ID --
|
|
2554
|
+
$ zitadel variables set GOOGLE_CLIENT_ID --project-level
|
|
2697
2555
|
|
|
2698
|
-
$ zitadel variables set GOOGLE_CLIENT_SECRET --
|
|
2556
|
+
$ zitadel variables set GOOGLE_CLIENT_SECRET --project-level --secret < secret.txt
|
|
2699
2557
|
|
|
2700
2558
|
$ zitadel variables set SESSION_TTL --project-level --as number
|
|
2701
2559
|
```
|