@zitadel/cli 0.1.0-alpha.9 → 0.2.0
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 +4043 -229
- package/bin/run.js +8 -0
- package/dist/index.mjs +24173 -0
- package/dist/index.mjs.map +1 -0
- package/dist/lib/oclif/help.mjs +117 -0
- package/dist/lib/oclif/help.mjs.map +1 -0
- package/dist/skills-hint-CBoak9HL.mjs +4348 -0
- package/dist/skills-hint-CBoak9HL.mjs.map +1 -0
- package/oclif.manifest.json +8635 -253
- package/package.json +106 -15
- package/skills/zitadel-cli/SKILL.md +538 -0
- package/skills/zitadel-cli/references/driving-login-ui.md +109 -0
- package/SKILLS.md +0 -157
- package/dist/commands/apply.mjs +0 -62
- package/dist/commands/apply.mjs.map +0 -1
- package/dist/commands/doctor.mjs +0 -569
- package/dist/commands/doctor.mjs.map +0 -1
- package/dist/commands/eject.mjs +0 -145
- package/dist/commands/eject.mjs.map +0 -1
- package/dist/commands/logs.mjs +0 -58
- package/dist/commands/logs.mjs.map +0 -1
- package/dist/commands/plan.mjs +0 -52
- package/dist/commands/plan.mjs.map +0 -1
- package/dist/commands/reset.mjs +0 -79
- package/dist/commands/reset.mjs.map +0 -1
- package/dist/commands/setup.mjs +0 -856
- package/dist/commands/setup.mjs.map +0 -1
- package/dist/commands/start.mjs +0 -288
- package/dist/commands/start.mjs.map +0 -1
- package/dist/commands/status.mjs +0 -112
- package/dist/commands/status.mjs.map +0 -1
- package/dist/commands/stop.mjs +0 -105
- package/dist/commands/stop.mjs.map +0 -1
- package/dist/docker-CnGQK3ZK.mjs +0 -432
- package/dist/docker-CnGQK3ZK.mjs.map +0 -1
- package/dist/docker-guidance-ypN3IM3o.mjs +0 -21
- package/dist/docker-guidance-ypN3IM3o.mjs.map +0 -1
- package/dist/oclif-B7lBzh3R.mjs +0 -808
- package/dist/oclif-B7lBzh3R.mjs.map +0 -1
- package/dist/orca-U142Wrau.mjs +0 -2556
- package/dist/orca-U142Wrau.mjs.map +0 -1
- package/dist/ports-B09RjuHx.mjs +0 -111
- package/dist/ports-B09RjuHx.mjs.map +0 -1
- package/dist/processes-Cw8TO1SY.mjs +0 -120
- package/dist/processes-Cw8TO1SY.mjs.map +0 -1
- package/dist/project-Cd0L3PtM.mjs +0 -87
- package/dist/project-Cd0L3PtM.mjs.map +0 -1
- package/dist/sync-BojoQm2P.mjs +0 -733
- package/dist/sync-BojoQm2P.mjs.map +0 -1
package/README.md
CHANGED
|
@@ -1,58 +1,76 @@
|
|
|
1
1
|
# @zitadel/cli
|
|
2
2
|
|
|
3
|
-
Scaffolds Zitadel auth (login, register, profile, middleware) into a Next.js, React, Vue, Angular, or
|
|
3
|
+
Scaffolds Zitadel auth (login, register, profile, middleware/proxy) into a Next.js, Nuxt, SvelteKit, SolidStart, Qwik Router, TanStack Start, React, Vue, Angular, Solid, Svelte, or Qwik app.
|
|
4
4
|
|
|
5
5
|
```sh
|
|
6
|
-
npx @zitadel/cli@
|
|
7
|
-
npx @zitadel/cli@
|
|
6
|
+
npx @zitadel/cli@latest start
|
|
7
|
+
npx @zitadel/cli@latest setup --server local
|
|
8
8
|
```
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
automation when reproducibility matters.
|
|
10
|
+
Use an exact version (`npx @zitadel/cli@0.1.0`) in bug reports and automation
|
|
11
|
+
when reproducibility matters.
|
|
13
12
|
|
|
14
|
-
> **
|
|
13
|
+
> **Preview.** This is the **next-generation Zitadel**, a ground-up rewrite of the platform. It is distinct from the established Zitadel at [github.com/zitadel/zitadel](https://github.com/zitadel/zitadel). APIs and CLI flags will change: until 1.0.0, a breaking change ships in a minor version, and its release note marks it **Breaking:**.
|
|
15
14
|
|
|
16
15
|
## Requirements
|
|
17
16
|
|
|
18
|
-
- Node 24
|
|
17
|
+
- Node from the supported range in `package.json#engines` (currently ≥ 24)
|
|
19
18
|
- Docker only when using the optional Docker runtime backend
|
|
20
|
-
-
|
|
19
|
+
- An app in one of the eight supported frameworks, or an empty directory
|
|
20
|
+
where setup can scaffold one
|
|
21
21
|
|
|
22
22
|
## Quickstart
|
|
23
23
|
|
|
24
24
|
```sh
|
|
25
25
|
mkdir my-app
|
|
26
26
|
cd my-app
|
|
27
|
-
npx @zitadel/cli@
|
|
28
|
-
npx @zitadel/cli@
|
|
29
|
-
npx @zitadel/cli@
|
|
27
|
+
npx @zitadel/cli@latest doctor
|
|
28
|
+
npx @zitadel/cli@latest start
|
|
29
|
+
npx @zitadel/cli@latest setup --server local
|
|
30
30
|
npm run dev
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
`start` runs the `@zitadel/server` npm binary by default and stores runtime data
|
|
34
|
-
under `.zitadel/local
|
|
35
|
-
starting a local runtime. Use `--runtime docker`,
|
|
36
|
-
`ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
|
|
34
|
+
under `.zitadel/local/` (SQLite by default). Remote-server setup can use
|
|
35
|
+
`--server <url>` without starting a local runtime. Use `--runtime docker`,
|
|
36
|
+
`--image`, or `ZITADEL_LOCAL_IMAGE` for advanced Docker backend debugging.
|
|
37
|
+
`start` also creates a local admin, `admin@zitadel.localhost`, and ends by
|
|
38
|
+
printing a one-time sign-in link for the management console.
|
|
37
39
|
`setup --server local` creates a project on that local server, asks which
|
|
38
|
-
framework to scaffold when the directory is fresh, writes the
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
40
|
+
framework to scaffold when the directory is fresh, writes the app into the
|
|
41
|
+
current directory, and scaffolds the framework's
|
|
42
|
+
idiomatic auth routes plus the proxy layer — for Next.js that means
|
|
43
|
+
`app/login`, `app/register`, `app/profile`, and `proxy.ts` for Next 16+ or
|
|
44
|
+
`middleware.ts` for older versions; other frameworks get their equivalents
|
|
45
|
+
from the same patcher system. In a pre-existing app, setup derives the
|
|
46
|
+
embedding posture from the app instead of assuming a fresh skeleton: the
|
|
47
|
+
scaffolded pages take the `variant="widget"` posture inside your app's own
|
|
48
|
+
shell, recorded in the scaffold manifest and verified by `doctor`. Fresh
|
|
49
|
+
scaffolds also replace the starter home page with a redirect to `/login`.
|
|
50
|
+
Against a local server started with the default platform bootstrap, setup also
|
|
51
|
+
attaches the new project to the local admin's team, so the project is owned
|
|
52
|
+
from the start and `zitadel claim` reports it as already owned. If you opted
|
|
53
|
+
out with `NEXTGEN_PLATFORM_BOOTSTRAP_PROJECT=false`, there is no local admin
|
|
54
|
+
and the project has no owning team; that server cannot claim projects.
|
|
55
|
+
Setup writes `.env.local` and `.zitadel/`, and installs
|
|
43
56
|
dependencies with the detected package manager. Pass `--skip-install` to install
|
|
44
57
|
them yourself. The project's default user schema and login flow are provisioned
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
58
|
+
from versioned local defaults; setup writes editable copies into
|
|
59
|
+
`.zitadel/schemas/default-human-user.json` and
|
|
60
|
+
`.zitadel/flows/default-login.json`, uploads them through the schema and flow
|
|
61
|
+
APIs, then seeds `.zitadel/state.json` so `zitadel plan` is immediately empty.
|
|
62
|
+
Open the dev server URL printed by your framework, register a user, log out,
|
|
63
|
+
log back in, and end on the signed-in profile page. That user is an end user
|
|
64
|
+
of your app. The management console is a separate sign-in: run
|
|
65
|
+
`zitadel console` for a fresh one-time link as the local admin.
|
|
66
|
+
|
|
67
|
+
For a reproducible tester report, use the exact version from the GitHub
|
|
50
68
|
Release:
|
|
51
69
|
|
|
52
70
|
```sh
|
|
53
|
-
npx @zitadel/cli@0.1.0
|
|
54
|
-
npx @zitadel/cli@0.1.0
|
|
55
|
-
npx @zitadel/cli@0.1.0
|
|
71
|
+
npx @zitadel/cli@0.1.0 doctor
|
|
72
|
+
npx @zitadel/cli@0.1.0 start
|
|
73
|
+
npx @zitadel/cli@0.1.0 setup --server local
|
|
56
74
|
```
|
|
57
75
|
|
|
58
76
|
The default project flow supports password registration/login, passkey
|
|
@@ -60,14 +78,51 @@ registration/login, and optional passkey setup after password registration.
|
|
|
60
78
|
Users who skip passkey setup can still sign in with password; users who add a
|
|
61
79
|
passkey can sign in with either credential.
|
|
62
80
|
|
|
81
|
+
Repo config is authoritative: edit `zitadel.json`, `.zitadel/schemas/*.json`,
|
|
82
|
+
`.zitadel/flows/*.json`, or `.zitadel/branding/` (a `branding.json` descriptor
|
|
83
|
+
plus a `login.liquid` LiquidJS template), then re-run `zitadel plan` and
|
|
84
|
+
`zitadel apply`. Server-provisioned defaults remain a fallback for non-CLI
|
|
85
|
+
project creation, but CLI-created projects are authored from local files first.
|
|
86
|
+
Login templates are supported: scaffold them with the `branding eject` command
|
|
87
|
+
(`--design centered|minimal`); setup never does;
|
|
88
|
+
every edit publishes a new immutable branding revision and the login serves
|
|
89
|
+
the newest one. Flows work the same way: every edit publishes a new immutable
|
|
90
|
+
flow revision. A page that pins `flow-name` gets that flow's newest revision. A
|
|
91
|
+
page without a pin gets the project's newest active unscoped flow, whatever its
|
|
92
|
+
name, so revising a flow can make it the default.
|
|
93
|
+
|
|
94
|
+
For agent scripts, pass `--non-interactive --json` and capture stdout and stderr
|
|
95
|
+
separately. The CLI contract is one parseable JSON object on stdout; terminals
|
|
96
|
+
and agent UIs may display stderr package-manager progress together with stdout.
|
|
97
|
+
|
|
63
98
|
## Other commands
|
|
64
99
|
|
|
65
|
-
- `zitadel
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
- `zitadel
|
|
69
|
-
|
|
70
|
-
-
|
|
100
|
+
- `zitadel claim`: claim the project to make it permanent (opens the claim
|
|
101
|
+
page, polls for completion; the claim then shows in `setup`, `status`, and
|
|
102
|
+
`doctor`)
|
|
103
|
+
- `zitadel console`: print a fresh one-time sign-in link for the local
|
|
104
|
+
console as `admin@zitadel.localhost` and open it in a browser
|
|
105
|
+
(`--no-open` prints the link only)
|
|
106
|
+
- `zitadel doctor`: verify the local runtime and generated project files
|
|
107
|
+
(including scaffold drift and dependency-version alignment)
|
|
108
|
+
- `zitadel status`: summarise the local runtime and project
|
|
109
|
+
- `zitadel deploy`: build a release from `.zitadel/` and deploy it to the
|
|
110
|
+
project's primary origins (`--dry-run` validates and previews only)
|
|
111
|
+
- `zitadel pull`: rebuild `.zitadel/` from the revisions a released snapshot
|
|
112
|
+
pins — the inverse of deploy — for `latest`, a release id, or a deployment id
|
|
113
|
+
- `zitadel branding eject`: scaffold an editable login template from a design
|
|
114
|
+
- `zitadel schemas list`: list the project's user schemas
|
|
115
|
+
- `zitadel variable set|get|list|rm`: manage the project's variables and secrets
|
|
116
|
+
(`--preview` for a preview override); `zitadel variable resolve` shows what a
|
|
117
|
+
target's live deployment runs
|
|
118
|
+
- `zitadel origin add|list|rm`: manage the origin patterns the project admits
|
|
119
|
+
(`--kind primary|preview`)
|
|
120
|
+
- `zitadel eject`: remove what setup wrote (alias: `zitadel uninstall`)
|
|
121
|
+
- `zitadel start|stop|logs|reset`: manage the local runtime
|
|
122
|
+
|
|
123
|
+
The full agent-facing contract (JSON envelope, posture rules, claim flow,
|
|
124
|
+
doctor repair) is [`SKILL.md`](https://github.com/zitadel/nextgen/blob/main/apps/cli/skills/zitadel-cli/SKILL.md),
|
|
125
|
+
which ships in this package.
|
|
71
126
|
|
|
72
127
|
## Reference
|
|
73
128
|
|
|
@@ -75,421 +130,4179 @@ passkey can sign in with either credential.
|
|
|
75
130
|
<summary>Full command reference</summary>
|
|
76
131
|
|
|
77
132
|
<!-- commands -->
|
|
78
|
-
* [`zitadel
|
|
133
|
+
* [`zitadel api [OPERATION]`](#zitadel-api-operation)
|
|
134
|
+
* [`zitadel api ls [FILTER]`](#zitadel-api-ls-filter)
|
|
135
|
+
* [`zitadel auth-method passkey disable`](#zitadel-auth-method-passkey-disable)
|
|
136
|
+
* [`zitadel auth-method passkey enable`](#zitadel-auth-method-passkey-enable)
|
|
137
|
+
* [`zitadel auth-method password disable`](#zitadel-auth-method-password-disable)
|
|
138
|
+
* [`zitadel auth-method password enable`](#zitadel-auth-method-password-enable)
|
|
139
|
+
* [`zitadel auth-method sso disable`](#zitadel-auth-method-sso-disable)
|
|
140
|
+
* [`zitadel auth-method sso enable`](#zitadel-auth-method-sso-enable)
|
|
79
141
|
* [`zitadel autocomplete [SHELL]`](#zitadel-autocomplete-shell)
|
|
142
|
+
* [`zitadel branding eject`](#zitadel-branding-eject)
|
|
143
|
+
* [`zitadel branding get ID`](#zitadel-branding-get-id)
|
|
144
|
+
* [`zitadel branding list`](#zitadel-branding-list)
|
|
145
|
+
* [`zitadel claim`](#zitadel-claim)
|
|
80
146
|
* [`zitadel commands`](#zitadel-commands)
|
|
147
|
+
* [`zitadel console`](#zitadel-console)
|
|
148
|
+
* [`zitadel deploy`](#zitadel-deploy)
|
|
149
|
+
* [`zitadel deployment create`](#zitadel-deployment-create)
|
|
150
|
+
* [`zitadel deployment get DEPLOYMENT_ID`](#zitadel-deployment-get-deployment_id)
|
|
151
|
+
* [`zitadel deployment list`](#zitadel-deployment-list)
|
|
152
|
+
* [`zitadel deployment rollback [DEPLOYMENT_ID]`](#zitadel-deployment-rollback-deployment_id)
|
|
81
153
|
* [`zitadel doctor`](#zitadel-doctor)
|
|
82
154
|
* [`zitadel eject`](#zitadel-eject)
|
|
155
|
+
* [`zitadel env`](#zitadel-env)
|
|
156
|
+
* [`zitadel env add NAME`](#zitadel-env-add-name)
|
|
157
|
+
* [`zitadel env list`](#zitadel-env-list)
|
|
158
|
+
* [`zitadel events get ID`](#zitadel-events-get-id)
|
|
159
|
+
* [`zitadel events list`](#zitadel-events-list)
|
|
160
|
+
* [`zitadel flow-definitions get FLOW`](#zitadel-flow-definitions-get-flow)
|
|
161
|
+
* [`zitadel flow-definitions list`](#zitadel-flow-definitions-list)
|
|
162
|
+
* [`zitadel grants create`](#zitadel-grants-create)
|
|
163
|
+
* [`zitadel grants delete ID`](#zitadel-grants-delete-id)
|
|
164
|
+
* [`zitadel grants get ID`](#zitadel-grants-get-id)
|
|
165
|
+
* [`zitadel grants list`](#zitadel-grants-list)
|
|
83
166
|
* [`zitadel help [COMMAND]`](#zitadel-help-command)
|
|
167
|
+
* [`zitadel idps create`](#zitadel-idps-create)
|
|
168
|
+
* [`zitadel idps get ID`](#zitadel-idps-get-id)
|
|
169
|
+
* [`zitadel idps list`](#zitadel-idps-list)
|
|
84
170
|
* [`zitadel logs`](#zitadel-logs)
|
|
85
|
-
* [`zitadel
|
|
171
|
+
* [`zitadel origin add PATTERN`](#zitadel-origin-add-pattern)
|
|
172
|
+
* [`zitadel origin list`](#zitadel-origin-list)
|
|
173
|
+
* [`zitadel origin rm PATTERN`](#zitadel-origin-rm-pattern)
|
|
174
|
+
* [`zitadel policies get POLICY`](#zitadel-policies-get-policy)
|
|
175
|
+
* [`zitadel policies list`](#zitadel-policies-list)
|
|
176
|
+
* [`zitadel preview`](#zitadel-preview)
|
|
177
|
+
* [`zitadel preview list`](#zitadel-preview-list)
|
|
178
|
+
* [`zitadel preview rm URL`](#zitadel-preview-rm-url)
|
|
179
|
+
* [`zitadel projects get ID`](#zitadel-projects-get-id)
|
|
180
|
+
* [`zitadel projects list`](#zitadel-projects-list)
|
|
181
|
+
* [`zitadel projects update ID`](#zitadel-projects-update-id)
|
|
182
|
+
* [`zitadel pull [TARGET]`](#zitadel-pull-target)
|
|
183
|
+
* [`zitadel release create`](#zitadel-release-create)
|
|
184
|
+
* [`zitadel release get ID`](#zitadel-release-get-id)
|
|
185
|
+
* [`zitadel release list`](#zitadel-release-list)
|
|
186
|
+
* [`zitadel release revoke RELEASE_ID`](#zitadel-release-revoke-release_id)
|
|
86
187
|
* [`zitadel reset`](#zitadel-reset)
|
|
188
|
+
* [`zitadel resources`](#zitadel-resources)
|
|
189
|
+
* [`zitadel schemas get SCHEMA`](#zitadel-schemas-get-schema)
|
|
190
|
+
* [`zitadel schemas list`](#zitadel-schemas-list)
|
|
87
191
|
* [`zitadel search`](#zitadel-search)
|
|
192
|
+
* [`zitadel sessions get ID`](#zitadel-sessions-get-id)
|
|
193
|
+
* [`zitadel sessions list`](#zitadel-sessions-list)
|
|
194
|
+
* [`zitadel sessions revoke ID`](#zitadel-sessions-revoke-id)
|
|
88
195
|
* [`zitadel setup`](#zitadel-setup)
|
|
89
196
|
* [`zitadel start`](#zitadel-start)
|
|
90
197
|
* [`zitadel status`](#zitadel-status)
|
|
91
198
|
* [`zitadel stop`](#zitadel-stop)
|
|
199
|
+
* [`zitadel teams create`](#zitadel-teams-create)
|
|
200
|
+
* [`zitadel teams deactivate ID`](#zitadel-teams-deactivate-id)
|
|
201
|
+
* [`zitadel teams get ID`](#zitadel-teams-get-id)
|
|
202
|
+
* [`zitadel teams list`](#zitadel-teams-list)
|
|
203
|
+
* [`zitadel teams update ID`](#zitadel-teams-update-id)
|
|
92
204
|
* [`zitadel uninstall`](#zitadel-uninstall)
|
|
205
|
+
* [`zitadel users create`](#zitadel-users-create)
|
|
206
|
+
* [`zitadel users delete ID`](#zitadel-users-delete-id)
|
|
207
|
+
* [`zitadel users get ID`](#zitadel-users-get-id)
|
|
208
|
+
* [`zitadel users list`](#zitadel-users-list)
|
|
209
|
+
* [`zitadel users update ID`](#zitadel-users-update-id)
|
|
210
|
+
* [`zitadel variable get NAME`](#zitadel-variable-get-name)
|
|
211
|
+
* [`zitadel variable list`](#zitadel-variable-list)
|
|
212
|
+
* [`zitadel variable resolve`](#zitadel-variable-resolve)
|
|
213
|
+
* [`zitadel variable rm NAME`](#zitadel-variable-rm-name)
|
|
214
|
+
* [`zitadel variable set NAME [VALUE]`](#zitadel-variable-set-name-value)
|
|
93
215
|
* [`zitadel version`](#zitadel-version)
|
|
94
216
|
* [`zitadel which`](#zitadel-which)
|
|
95
217
|
|
|
96
|
-
## `zitadel
|
|
218
|
+
## `zitadel api [OPERATION]`
|
|
97
219
|
|
|
98
|
-
|
|
220
|
+
Call any operation of the Zitadel API, with this project's server and project secret.
|
|
99
221
|
|
|
100
222
|
```
|
|
101
223
|
USAGE
|
|
102
|
-
$ zitadel
|
|
103
|
-
|
|
224
|
+
$ zitadel api [OPERATION...] [--json] [-c <value>] [-s <value>]
|
|
225
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-X
|
|
226
|
+
GET|POST|PUT|PATCH|DELETE] [-F <value>...] [--input <value>] [--paginate]
|
|
227
|
+
|
|
228
|
+
ARGUMENTS
|
|
229
|
+
[OPERATION...] An operationId (queryUsers) or a path (/users/query), then the
|
|
230
|
+
path parameters. Omit it to choose one.
|
|
104
231
|
|
|
105
232
|
FLAGS
|
|
106
|
-
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
233
|
+
-F, --field=<value>... A field: name=value, or name:=json for
|
|
234
|
+
JSON, typed by the operation's schema.
|
|
235
|
+
A query parameter's name sets it; any
|
|
236
|
+
other name is a dot path into the
|
|
237
|
+
body. Repeatable.
|
|
238
|
+
-X, --method=GET|POST|PUT|PATCH|DELETE The HTTP method, to choose among a
|
|
239
|
+
path's operations.
|
|
240
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
241
|
+
-n, --non-interactive Disable prompts. Required when
|
|
242
|
+
scripting or running as an agent.
|
|
243
|
+
-s, --server=<value> Override the resolved server URL.
|
|
244
|
+
-v, --verbose Verbose logging.
|
|
245
|
+
--[no-]color Colorize human output. Disable with
|
|
246
|
+
--no-color; NO_COLOR and FORCE_COLOR
|
|
247
|
+
are honored too.
|
|
248
|
+
--debug Debug logging.
|
|
249
|
+
--dry-run Preview without mutating files or the
|
|
250
|
+
platform.
|
|
251
|
+
--input=<value> Read the JSON body from a file, or
|
|
252
|
+
from stdin with -. --field lays over
|
|
253
|
+
it.
|
|
254
|
+
--paginate Follow next_page_token to the last
|
|
255
|
+
page, and answer with every page's
|
|
256
|
+
items in one list.
|
|
257
|
+
--[no-]telemetry Send anonymous usage analytics.
|
|
258
|
+
Disable with --no-telemetry.
|
|
115
259
|
|
|
116
260
|
GLOBAL FLAGS
|
|
117
261
|
--json Format output as json.
|
|
118
262
|
|
|
119
263
|
DESCRIPTION
|
|
120
|
-
|
|
264
|
+
Call any operation of the Zitadel API, with this project's server and project
|
|
265
|
+
secret.
|
|
266
|
+
|
|
267
|
+
EXAMPLES
|
|
268
|
+
$ zitadel api queryUsers -F limit=5
|
|
269
|
+
|
|
270
|
+
$ zitadel api GetUserByID user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W
|
|
271
|
+
|
|
272
|
+
$ zitadel api /users/user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W/passkeys --json
|
|
273
|
+
|
|
274
|
+
$ zitadel api listEvents -F category=auth --paginate --json
|
|
275
|
+
|
|
276
|
+
$ zitadel api createTeam -F name=Support --dry-run
|
|
277
|
+
|
|
278
|
+
$ zitadel api createTeam --input - < team.json
|
|
121
279
|
```
|
|
122
280
|
|
|
123
|
-
## `zitadel
|
|
281
|
+
## `zitadel api ls [FILTER]`
|
|
124
282
|
|
|
125
|
-
|
|
283
|
+
List the operations of the Zitadel API that `zitadel api` calls.
|
|
126
284
|
|
|
127
285
|
```
|
|
128
286
|
USAGE
|
|
129
|
-
$ zitadel
|
|
287
|
+
$ zitadel api ls [FILTER] [--json] [-c <value>] [-s <value>] [-n]
|
|
288
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--tag <value>]
|
|
130
289
|
|
|
131
290
|
ARGUMENTS
|
|
132
|
-
[
|
|
291
|
+
[FILTER] Only operations whose id, path, summary or tag contains this text.
|
|
133
292
|
|
|
134
293
|
FLAGS
|
|
135
|
-
-
|
|
294
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
295
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
296
|
+
an agent.
|
|
297
|
+
-s, --server=<value> Override the resolved server URL.
|
|
298
|
+
-v, --verbose Verbose logging.
|
|
299
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
300
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
301
|
+
--debug Debug logging.
|
|
302
|
+
--dry-run Preview without mutating files or the platform.
|
|
303
|
+
--tag=<value> Only the operations of this part of the API (Users,
|
|
304
|
+
Teams, …).
|
|
305
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
306
|
+
--no-telemetry.
|
|
307
|
+
|
|
308
|
+
GLOBAL FLAGS
|
|
309
|
+
--json Format output as json.
|
|
136
310
|
|
|
137
311
|
DESCRIPTION
|
|
138
|
-
|
|
312
|
+
List the operations of the Zitadel API that `zitadel api` calls.
|
|
139
313
|
|
|
140
314
|
EXAMPLES
|
|
141
|
-
$ zitadel
|
|
315
|
+
$ zitadel api ls
|
|
142
316
|
|
|
143
|
-
$ zitadel
|
|
317
|
+
$ zitadel api ls passkey
|
|
144
318
|
|
|
145
|
-
$ zitadel
|
|
319
|
+
$ zitadel api ls --tag Users --json
|
|
146
320
|
|
|
147
|
-
$ zitadel
|
|
321
|
+
$ zitadel api ls --json | jq -r '.data.operations[] | select(.command == null) | .id'
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
## `zitadel auth-method passkey disable`
|
|
325
|
+
|
|
326
|
+
Disable passkey sign-in for a user schema.
|
|
148
327
|
|
|
149
|
-
$ zitadel autocomplete --refresh-cache
|
|
150
328
|
```
|
|
329
|
+
USAGE
|
|
330
|
+
$ zitadel auth-method passkey disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
331
|
+
[--debug] [--color] [--telemetry] [--schema <value>] [-f]
|
|
151
332
|
|
|
152
|
-
|
|
333
|
+
FLAGS
|
|
334
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
335
|
+
-f, --force Disable the schema's last way to sign in. Its users can
|
|
336
|
+
then only be managed through the API.
|
|
337
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
338
|
+
an agent.
|
|
339
|
+
-s, --server=<value> Override the resolved server URL.
|
|
340
|
+
-v, --verbose Verbose logging.
|
|
341
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
342
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
343
|
+
--debug Debug logging.
|
|
344
|
+
--dry-run Preview without mutating files or the platform.
|
|
345
|
+
--schema=<value> User schema to change. Required when the Project has
|
|
346
|
+
more than one.
|
|
347
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
348
|
+
--no-telemetry.
|
|
153
349
|
|
|
154
|
-
|
|
350
|
+
DESCRIPTION
|
|
351
|
+
Disable passkey sign-in for a user schema.
|
|
155
352
|
|
|
156
|
-
|
|
353
|
+
EXAMPLES
|
|
354
|
+
$ zitadel auth-method passkey disable
|
|
355
|
+
|
|
356
|
+
$ zitadel auth-method passkey disable --schema customers
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
## `zitadel auth-method passkey enable`
|
|
360
|
+
|
|
361
|
+
Enable passkey sign-in for a user schema.
|
|
157
362
|
|
|
158
363
|
```
|
|
159
364
|
USAGE
|
|
160
|
-
$ zitadel
|
|
161
|
-
[--
|
|
365
|
+
$ zitadel auth-method passkey enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
366
|
+
[--debug] [--color] [--telemetry] [--schema <value>]
|
|
162
367
|
|
|
163
368
|
FLAGS
|
|
164
|
-
-c, --
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
--no-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
--
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
369
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
370
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
371
|
+
an agent.
|
|
372
|
+
-s, --server=<value> Override the resolved server URL.
|
|
373
|
+
-v, --verbose Verbose logging.
|
|
374
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
375
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
376
|
+
--debug Debug logging.
|
|
377
|
+
--dry-run Preview without mutating files or the platform.
|
|
378
|
+
--schema=<value> User schema to change. Required when the Project has
|
|
379
|
+
more than one.
|
|
380
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
381
|
+
--no-telemetry.
|
|
176
382
|
|
|
177
383
|
DESCRIPTION
|
|
178
|
-
|
|
179
|
-
```
|
|
384
|
+
Enable passkey sign-in for a user schema.
|
|
180
385
|
|
|
181
|
-
|
|
386
|
+
EXAMPLES
|
|
387
|
+
$ zitadel auth-method passkey enable
|
|
182
388
|
|
|
183
|
-
|
|
389
|
+
$ zitadel auth-method passkey enable --schema customers
|
|
390
|
+
```
|
|
184
391
|
|
|
185
|
-
|
|
392
|
+
## `zitadel auth-method password disable`
|
|
393
|
+
|
|
394
|
+
Disable password sign-in for a user schema.
|
|
186
395
|
|
|
187
396
|
```
|
|
188
397
|
USAGE
|
|
189
|
-
$ zitadel
|
|
190
|
-
[--
|
|
398
|
+
$ zitadel auth-method password disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
399
|
+
[--debug] [--color] [--telemetry] [--schema <value>] [-f]
|
|
191
400
|
|
|
192
401
|
FLAGS
|
|
193
402
|
-c, --cwd=<value> Project directory to operate on.
|
|
194
|
-
-f, --force
|
|
195
|
-
|
|
403
|
+
-f, --force Disable the schema's last way to sign in. Its users can
|
|
404
|
+
then only be managed through the API.
|
|
405
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
406
|
+
an agent.
|
|
196
407
|
-s, --server=<value> Override the resolved server URL.
|
|
408
|
+
-v, --verbose Verbose logging.
|
|
409
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
410
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
197
411
|
--debug Debug logging.
|
|
198
412
|
--dry-run Preview without mutating files or the platform.
|
|
199
|
-
--
|
|
200
|
-
|
|
201
|
-
--
|
|
202
|
-
|
|
203
|
-
<options: binary|docker>
|
|
204
|
-
--verbose Verbose logging.
|
|
205
|
-
|
|
206
|
-
GLOBAL FLAGS
|
|
207
|
-
--json Format output as json.
|
|
413
|
+
--schema=<value> User schema to change. Required when the Project has
|
|
414
|
+
more than one.
|
|
415
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
416
|
+
--no-telemetry.
|
|
208
417
|
|
|
209
418
|
DESCRIPTION
|
|
210
|
-
|
|
419
|
+
Disable password sign-in for a user schema.
|
|
420
|
+
|
|
421
|
+
EXAMPLES
|
|
422
|
+
$ zitadel auth-method password disable
|
|
423
|
+
|
|
424
|
+
$ zitadel auth-method password disable --schema customers
|
|
211
425
|
```
|
|
212
426
|
|
|
213
|
-
## `zitadel
|
|
427
|
+
## `zitadel auth-method password enable`
|
|
214
428
|
|
|
215
|
-
|
|
429
|
+
Enable password sign-in for a user schema.
|
|
216
430
|
|
|
217
431
|
```
|
|
218
432
|
USAGE
|
|
219
|
-
$ zitadel
|
|
433
|
+
$ zitadel auth-method password enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
434
|
+
[--debug] [--color] [--telemetry] [--schema <value>]
|
|
220
435
|
|
|
221
436
|
FLAGS
|
|
222
437
|
-c, --cwd=<value> Project directory to operate on.
|
|
223
|
-
-
|
|
224
|
-
|
|
438
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
439
|
+
an agent.
|
|
225
440
|
-s, --server=<value> Override the resolved server URL.
|
|
441
|
+
-v, --verbose Verbose logging.
|
|
442
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
443
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
226
444
|
--debug Debug logging.
|
|
227
445
|
--dry-run Preview without mutating files or the platform.
|
|
228
|
-
--
|
|
446
|
+
--schema=<value> User schema to change. Required when the Project has
|
|
447
|
+
more than one.
|
|
448
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
449
|
+
--no-telemetry.
|
|
229
450
|
|
|
230
|
-
|
|
231
|
-
|
|
451
|
+
DESCRIPTION
|
|
452
|
+
Enable password sign-in for a user schema.
|
|
453
|
+
|
|
454
|
+
EXAMPLES
|
|
455
|
+
$ zitadel auth-method password enable
|
|
456
|
+
|
|
457
|
+
$ zitadel auth-method password enable --schema customers
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
## `zitadel auth-method sso disable`
|
|
461
|
+
|
|
462
|
+
Remove an identity provider from a user schema.
|
|
463
|
+
|
|
464
|
+
```
|
|
465
|
+
USAGE
|
|
466
|
+
$ zitadel auth-method sso disable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
467
|
+
[--debug] [--color] [--telemetry] [--schema <value>] [--provider <value>]
|
|
468
|
+
[-f]
|
|
469
|
+
|
|
470
|
+
FLAGS
|
|
471
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
472
|
+
-f, --force Disable the schema's last way to sign in. Its users
|
|
473
|
+
can then only be managed through the API.
|
|
474
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
475
|
+
an agent.
|
|
476
|
+
-s, --server=<value> Override the resolved server URL.
|
|
477
|
+
-v, --verbose Verbose logging.
|
|
478
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
479
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
480
|
+
--debug Debug logging.
|
|
481
|
+
--dry-run Preview without mutating files or the platform.
|
|
482
|
+
--provider=<value> Identity provider to remove.
|
|
483
|
+
--schema=<value> User schema to change. Required when the Project has
|
|
484
|
+
more than one.
|
|
485
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
486
|
+
--no-telemetry.
|
|
232
487
|
|
|
233
488
|
DESCRIPTION
|
|
234
|
-
Remove
|
|
489
|
+
Remove an identity provider from a user schema.
|
|
235
490
|
|
|
236
|
-
|
|
237
|
-
$ zitadel
|
|
491
|
+
EXAMPLES
|
|
492
|
+
$ zitadel auth-method sso disable --provider google
|
|
493
|
+
|
|
494
|
+
$ zitadel auth-method sso disable --provider google --schema customers
|
|
238
495
|
```
|
|
239
496
|
|
|
240
|
-
## `zitadel
|
|
497
|
+
## `zitadel auth-method sso enable`
|
|
241
498
|
|
|
242
|
-
|
|
499
|
+
Add an identity provider to a user schema.
|
|
243
500
|
|
|
244
501
|
```
|
|
245
502
|
USAGE
|
|
246
|
-
$ zitadel
|
|
503
|
+
$ zitadel auth-method sso enable [-c <value>] [-s <value>] [-n] [--dry-run] [-v]
|
|
504
|
+
[--debug] [--color] [--telemetry] [-e <value>] [--env-file <value>]
|
|
505
|
+
[--schema <value>] [--provider google|custom] [--slug <value>]
|
|
506
|
+
[--display-name <value>] [--issuer <value>] [--scopes <value>] [--client-id
|
|
507
|
+
<value>]
|
|
508
|
+
|
|
509
|
+
FLAGS
|
|
510
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
511
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
512
|
+
Defaults to ZITADEL_ENV, then the hosting
|
|
513
|
+
platform's build (VERCEL_ENV, or Netlify's
|
|
514
|
+
CONTEXT), then development.
|
|
515
|
+
-n, --non-interactive Disable prompts. Required when scripting or
|
|
516
|
+
running as an agent.
|
|
517
|
+
-s, --server=<value> Override the resolved server URL.
|
|
518
|
+
-v, --verbose Verbose logging.
|
|
519
|
+
--client-id=<value> Client id of the application registered with the
|
|
520
|
+
provider.
|
|
521
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
522
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
523
|
+
--debug Debug logging.
|
|
524
|
+
--display-name=<value> Name shown on the custom connection's sign-in
|
|
525
|
+
button.
|
|
526
|
+
--dry-run Preview without mutating files or the platform.
|
|
527
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
528
|
+
process environment. Cannot be combined with
|
|
529
|
+
--env.
|
|
530
|
+
--issuer=<value> Issuer URL of the custom provider. Its endpoints
|
|
531
|
+
are found by OIDC discovery.
|
|
532
|
+
--provider=<option> Identity provider to enable, or "custom" for a
|
|
533
|
+
custom OpenID Connect (OIDC) provider.
|
|
534
|
+
<options: google|custom>
|
|
535
|
+
--schema=<value> User schema to change. Required when the Project
|
|
536
|
+
has more than one.
|
|
537
|
+
--scopes=<value> Scopes the custom connection requests, separated
|
|
538
|
+
by spaces or commas. Must include openid. Default:
|
|
539
|
+
openid profile email.
|
|
540
|
+
--slug=<value> Name of the custom connection. Schemas and flows
|
|
541
|
+
refer to it by this.
|
|
542
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
543
|
+
--no-telemetry.
|
|
544
|
+
|
|
545
|
+
DESCRIPTION
|
|
546
|
+
Add an identity provider to a user schema.
|
|
547
|
+
|
|
548
|
+
EXAMPLES
|
|
549
|
+
$ zitadel auth-method sso enable --provider google
|
|
550
|
+
|
|
551
|
+
$ zitadel auth-method sso enable --provider google --schema customers
|
|
552
|
+
|
|
553
|
+
$ zitadel auth-method sso enable --provider google --client-id 1234-abc.apps.googleusercontent.com --non-interactive < secret.txt
|
|
554
|
+
|
|
555
|
+
$ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example
|
|
556
|
+
|
|
557
|
+
$ zitadel auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example --scopes 'openid profile email groups' --client-id abc123 --non-interactive < secret.txt
|
|
558
|
+
```
|
|
559
|
+
|
|
560
|
+
## `zitadel autocomplete [SHELL]`
|
|
561
|
+
|
|
562
|
+
Display autocomplete installation instructions.
|
|
563
|
+
|
|
564
|
+
```
|
|
565
|
+
USAGE
|
|
566
|
+
$ zitadel autocomplete [SHELL] [-r]
|
|
247
567
|
|
|
248
568
|
ARGUMENTS
|
|
249
|
-
[
|
|
569
|
+
[SHELL] (zsh|bash|powershell) Shell type
|
|
250
570
|
|
|
251
571
|
FLAGS
|
|
252
|
-
-
|
|
572
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
253
573
|
|
|
254
574
|
DESCRIPTION
|
|
255
|
-
Display
|
|
575
|
+
Display autocomplete installation instructions.
|
|
576
|
+
|
|
577
|
+
EXAMPLES
|
|
578
|
+
$ zitadel autocomplete
|
|
579
|
+
|
|
580
|
+
$ zitadel autocomplete bash
|
|
581
|
+
|
|
582
|
+
$ zitadel autocomplete zsh
|
|
583
|
+
|
|
584
|
+
$ zitadel autocomplete powershell
|
|
585
|
+
|
|
586
|
+
$ zitadel autocomplete --refresh-cache
|
|
256
587
|
```
|
|
257
588
|
|
|
258
|
-
_See code: [@oclif/plugin-
|
|
589
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.50/src/commands/autocomplete/index.ts)_
|
|
259
590
|
|
|
260
|
-
## `zitadel
|
|
591
|
+
## `zitadel branding eject`
|
|
261
592
|
|
|
262
|
-
|
|
593
|
+
Take ownership of the login template: scaffold .zitadel/branding/ from a shipped design.
|
|
263
594
|
|
|
264
595
|
```
|
|
265
596
|
USAGE
|
|
266
|
-
$ zitadel
|
|
267
|
-
[--
|
|
597
|
+
$ zitadel branding eject [--json] [-c <value>] [-s <value>] [-n]
|
|
598
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--design <value>]
|
|
268
599
|
|
|
269
600
|
FLAGS
|
|
270
601
|
-c, --cwd=<value> Project directory to operate on.
|
|
271
|
-
-f, --force Overwrite
|
|
272
|
-
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
602
|
+
-f, --force Overwrite an existing branding file.
|
|
603
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
604
|
+
an agent.
|
|
273
605
|
-s, --server=<value> Override the resolved server URL.
|
|
606
|
+
-v, --verbose Verbose logging.
|
|
607
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
608
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
274
609
|
--debug Debug logging.
|
|
610
|
+
--design=<value> Design to start from: centered or minimal (default:
|
|
611
|
+
centered).
|
|
275
612
|
--dry-run Preview without mutating files or the platform.
|
|
276
|
-
--
|
|
277
|
-
|
|
278
|
-
--verbose Verbose logging.
|
|
613
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
614
|
+
--no-telemetry.
|
|
279
615
|
|
|
280
616
|
GLOBAL FLAGS
|
|
281
617
|
--json Format output as json.
|
|
282
618
|
|
|
283
619
|
DESCRIPTION
|
|
284
|
-
|
|
620
|
+
Take ownership of the login template: scaffold .zitadel/branding/ from a
|
|
621
|
+
shipped design.
|
|
285
622
|
```
|
|
286
623
|
|
|
287
|
-
## `zitadel
|
|
624
|
+
## `zitadel branding get ID`
|
|
288
625
|
|
|
289
|
-
|
|
626
|
+
Get one branding revision by id.
|
|
290
627
|
|
|
291
628
|
```
|
|
292
629
|
USAGE
|
|
293
|
-
$ zitadel
|
|
294
|
-
|
|
630
|
+
$ zitadel branding get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
631
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
632
|
+
<value>] [--fields <value>]
|
|
633
|
+
|
|
634
|
+
ARGUMENTS
|
|
635
|
+
ID branding revision id
|
|
295
636
|
|
|
296
637
|
FLAGS
|
|
297
|
-
-c, --cwd=<value>
|
|
298
|
-
-e, --
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
-n, --non-interactive
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
--
|
|
638
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
639
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
640
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
641
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
642
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
643
|
+
an agent.
|
|
644
|
+
-s, --server=<value> Override the resolved server URL.
|
|
645
|
+
-v, --verbose Verbose logging.
|
|
646
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
647
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
648
|
+
--debug Debug logging.
|
|
649
|
+
--dry-run Preview without mutating files or the platform.
|
|
650
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
651
|
+
process environment. Cannot be combined with --env.
|
|
652
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
653
|
+
the resource's own; `--json` is unaffected.
|
|
654
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
655
|
+
--no-telemetry.
|
|
306
656
|
|
|
307
657
|
GLOBAL FLAGS
|
|
308
658
|
--json Format output as json.
|
|
309
659
|
|
|
310
660
|
DESCRIPTION
|
|
311
|
-
|
|
661
|
+
Get one branding revision by id.
|
|
662
|
+
|
|
663
|
+
EXAMPLES
|
|
664
|
+
$ zitadel branding get <id>
|
|
665
|
+
|
|
666
|
+
$ zitadel branding get <id> --json
|
|
312
667
|
```
|
|
313
668
|
|
|
314
|
-
## `zitadel
|
|
669
|
+
## `zitadel branding list`
|
|
315
670
|
|
|
316
|
-
|
|
671
|
+
List branding.
|
|
317
672
|
|
|
318
673
|
```
|
|
319
674
|
USAGE
|
|
320
|
-
$ zitadel
|
|
675
|
+
$ zitadel branding list [--json] [-c <value>] [-s <value>] [-n]
|
|
676
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
677
|
+
<value>] [--fields <value>] [--plain]
|
|
321
678
|
|
|
322
679
|
FLAGS
|
|
323
|
-
-c, --cwd=<value>
|
|
324
|
-
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
680
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
681
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
682
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
683
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
684
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
685
|
+
an agent.
|
|
686
|
+
-s, --server=<value> Override the resolved server URL.
|
|
687
|
+
-v, --verbose Verbose logging.
|
|
688
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
689
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
690
|
+
--debug Debug logging.
|
|
691
|
+
--dry-run Preview without mutating files or the platform.
|
|
692
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
693
|
+
process environment. Cannot be combined with --env.
|
|
694
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
695
|
+
id,attributes.email). Defaults to the resource's own
|
|
696
|
+
columns; `--json` is unaffected.
|
|
697
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
698
|
+
when stdout is not a terminal.
|
|
699
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
700
|
+
--no-telemetry.
|
|
330
701
|
|
|
331
702
|
GLOBAL FLAGS
|
|
332
703
|
--json Format output as json.
|
|
333
704
|
|
|
334
705
|
DESCRIPTION
|
|
335
|
-
|
|
706
|
+
List branding.
|
|
707
|
+
|
|
708
|
+
EXAMPLES
|
|
709
|
+
$ zitadel branding list --json
|
|
336
710
|
```
|
|
337
711
|
|
|
338
|
-
## `zitadel
|
|
712
|
+
## `zitadel claim`
|
|
339
713
|
|
|
340
|
-
|
|
714
|
+
Claim this project to make it permanent. Opens a browser to create an account or sign in.
|
|
341
715
|
|
|
342
716
|
```
|
|
343
717
|
USAGE
|
|
344
|
-
$ zitadel
|
|
718
|
+
$ zitadel claim [--json] [-c <value>] [-s <value>] [-n]
|
|
719
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
720
|
+
<value>] [--no-open] [--no-wait | --challenge-id <value> | --timeout
|
|
721
|
+
<value>]
|
|
722
|
+
|
|
723
|
+
FLAGS
|
|
724
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
725
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
726
|
+
Defaults to ZITADEL_ENV, then the hosting
|
|
727
|
+
platform's build (VERCEL_ENV, or Netlify's
|
|
728
|
+
CONTEXT), then development.
|
|
729
|
+
-n, --non-interactive Disable prompts. Required when scripting or
|
|
730
|
+
running as an agent.
|
|
731
|
+
-s, --server=<value> Override the resolved server URL.
|
|
732
|
+
-v, --verbose Verbose logging.
|
|
733
|
+
--challenge-id=<value> Wait for the link a --no-wait run printed, instead
|
|
734
|
+
of creating a new one.
|
|
735
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
736
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
737
|
+
--debug Debug logging.
|
|
738
|
+
--dry-run Preview without mutating files or the platform.
|
|
739
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
740
|
+
process environment. Cannot be combined with
|
|
741
|
+
--env.
|
|
742
|
+
--no-open Print the link instead of opening a browser.
|
|
743
|
+
--no-wait Print the link and exit, without opening a browser
|
|
744
|
+
or waiting for the browser step. The result names
|
|
745
|
+
the command that waits for it.
|
|
746
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
747
|
+
--no-telemetry.
|
|
748
|
+
--timeout=<value> Seconds to wait for the browser step. Defaults to
|
|
749
|
+
the link's own expiry (10 minutes).
|
|
750
|
+
|
|
751
|
+
GLOBAL FLAGS
|
|
752
|
+
--json Format output as json.
|
|
345
753
|
|
|
346
754
|
DESCRIPTION
|
|
347
|
-
|
|
755
|
+
Claim this project to make it permanent. Opens a browser to create an account
|
|
756
|
+
or sign in.
|
|
348
757
|
|
|
349
|
-
|
|
350
|
-
|
|
758
|
+
EXAMPLES
|
|
759
|
+
$ zitadel claim
|
|
351
760
|
|
|
352
|
-
|
|
761
|
+
$ zitadel claim --no-open
|
|
353
762
|
|
|
354
|
-
|
|
763
|
+
$ zitadel claim --timeout 120
|
|
764
|
+
|
|
765
|
+
$ zitadel claim --no-wait
|
|
766
|
+
|
|
767
|
+
$ zitadel claim --challenge-id ch_01J0Z9KX7Y0Q2Y7JX5M9K2YF3C
|
|
768
|
+
```
|
|
769
|
+
|
|
770
|
+
## `zitadel commands`
|
|
355
771
|
|
|
356
|
-
|
|
772
|
+
List all zitadel commands.
|
|
357
773
|
|
|
358
774
|
```
|
|
359
775
|
USAGE
|
|
360
|
-
$ zitadel
|
|
361
|
-
[--
|
|
776
|
+
$ zitadel commands [--json] [-c id|plugin|summary|type... | --tree]
|
|
777
|
+
[--deprecated] [-x | ] [--hidden] [--no-truncate | ] [--sort
|
|
778
|
+
id|plugin|summary|type | ]
|
|
362
779
|
|
|
363
780
|
FLAGS
|
|
364
|
-
-c, --
|
|
365
|
-
|
|
366
|
-
-
|
|
367
|
-
|
|
368
|
-
--
|
|
369
|
-
--
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
--
|
|
373
|
-
<options: next|nuxt|react|vue|angular>
|
|
374
|
-
--renderer=<option> Renderer (default: react).
|
|
375
|
-
<options: react|web-component>
|
|
376
|
-
--skip-install Do not install dependencies after setup updates package.json.
|
|
377
|
-
--verbose Verbose logging.
|
|
781
|
+
-c, --columns=<option>... Only show provided columns (comma-separated).
|
|
782
|
+
<options: id|plugin|summary|type>
|
|
783
|
+
-x, --extended Show extra columns.
|
|
784
|
+
--deprecated Show deprecated commands.
|
|
785
|
+
--hidden Show hidden commands.
|
|
786
|
+
--no-truncate Do not truncate output.
|
|
787
|
+
--sort=<option> [default: id] Property to sort by.
|
|
788
|
+
<options: id|plugin|summary|type>
|
|
789
|
+
--tree Show tree of commands.
|
|
378
790
|
|
|
379
791
|
GLOBAL FLAGS
|
|
380
792
|
--json Format output as json.
|
|
381
793
|
|
|
382
794
|
DESCRIPTION
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
EXAMPLES
|
|
386
|
-
$ zitadel setup --framework next
|
|
387
|
-
|
|
388
|
-
$ zitadel setup --framework react --dev-port 3000
|
|
795
|
+
List all zitadel commands.
|
|
389
796
|
```
|
|
390
797
|
|
|
391
|
-
|
|
798
|
+
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/4.1.55/src/commands/commands.ts)_
|
|
392
799
|
|
|
393
|
-
|
|
800
|
+
## `zitadel console`
|
|
801
|
+
|
|
802
|
+
Open the local console, signed in as the local admin.
|
|
394
803
|
|
|
395
804
|
```
|
|
396
805
|
USAGE
|
|
397
|
-
$ zitadel
|
|
398
|
-
|
|
806
|
+
$ zitadel console [--json] [-c <value>] [-s <value>] [-n]
|
|
807
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--no-open]
|
|
399
808
|
|
|
400
809
|
FLAGS
|
|
401
810
|
-c, --cwd=<value> Project directory to operate on.
|
|
402
|
-
-
|
|
403
|
-
|
|
811
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
812
|
+
an agent.
|
|
404
813
|
-s, --server=<value> Override the resolved server URL.
|
|
814
|
+
-v, --verbose Verbose logging.
|
|
815
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
816
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
405
817
|
--debug Debug logging.
|
|
406
818
|
--dry-run Preview without mutating files or the platform.
|
|
407
|
-
--
|
|
408
|
-
--
|
|
409
|
-
|
|
410
|
-
<options: binary|docker>
|
|
411
|
-
--verbose Verbose logging.
|
|
819
|
+
--no-open Print the sign-in link instead of opening a browser.
|
|
820
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
821
|
+
--no-telemetry.
|
|
412
822
|
|
|
413
823
|
GLOBAL FLAGS
|
|
414
824
|
--json Format output as json.
|
|
415
825
|
|
|
416
826
|
DESCRIPTION
|
|
417
|
-
|
|
827
|
+
Open the local console, signed in as the local admin.
|
|
828
|
+
|
|
829
|
+
The local admin is the one `zitadel start` created. Run this in the directory
|
|
830
|
+
`zitadel start` ran in, or one inside it: the local admin is read from the
|
|
831
|
+
nearest `.zitadel/local/` on the way up.
|
|
832
|
+
|
|
833
|
+
EXAMPLES
|
|
834
|
+
$ zitadel console
|
|
835
|
+
|
|
836
|
+
$ zitadel console --no-open
|
|
418
837
|
```
|
|
419
838
|
|
|
420
|
-
## `zitadel
|
|
839
|
+
## `zitadel deploy`
|
|
421
840
|
|
|
422
|
-
|
|
841
|
+
Apply your local configuration to Zitadel.
|
|
423
842
|
|
|
424
843
|
```
|
|
425
844
|
USAGE
|
|
426
|
-
$ zitadel
|
|
845
|
+
$ zitadel deploy [--json] [-c <value>] [-s <value>] [-n]
|
|
846
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
847
|
+
<value>] [-m <value>]
|
|
427
848
|
|
|
428
849
|
FLAGS
|
|
429
|
-
-c, --cwd=<value>
|
|
430
|
-
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
850
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
851
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
852
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
853
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
854
|
+
-m, --message=<value> A short summary of what this release changes.
|
|
855
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
856
|
+
an agent.
|
|
857
|
+
-s, --server=<value> Override the resolved server URL.
|
|
858
|
+
-v, --verbose Verbose logging.
|
|
859
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
860
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
861
|
+
--debug Debug logging.
|
|
862
|
+
--dry-run Preview without mutating files or the platform.
|
|
863
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
864
|
+
process environment. Cannot be combined with --env.
|
|
865
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
866
|
+
--no-telemetry.
|
|
436
867
|
|
|
437
868
|
GLOBAL FLAGS
|
|
438
869
|
--json Format output as json.
|
|
439
870
|
|
|
440
871
|
DESCRIPTION
|
|
441
|
-
|
|
872
|
+
Apply your local configuration to Zitadel.
|
|
873
|
+
|
|
874
|
+
Builds a release from .zitadel/ and deploys it to the project. Use --dry-run
|
|
875
|
+
to preview what would change.
|
|
876
|
+
|
|
877
|
+
EXAMPLES
|
|
878
|
+
$ zitadel deploy -m 'add phone_number to human-user'
|
|
879
|
+
|
|
880
|
+
$ zitadel deploy --dry-run
|
|
442
881
|
```
|
|
443
882
|
|
|
444
|
-
## `zitadel
|
|
883
|
+
## `zitadel deployment create`
|
|
445
884
|
|
|
446
|
-
|
|
885
|
+
Deploy an existing release to the project's origins.
|
|
447
886
|
|
|
448
887
|
```
|
|
449
888
|
USAGE
|
|
450
|
-
$ zitadel
|
|
889
|
+
$ zitadel deployment create --release <value> [--json] [-c <value>] [-s
|
|
890
|
+
<value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
|
|
891
|
+
<value>] [--env-file <value>] [-m <value>]
|
|
451
892
|
|
|
452
893
|
FLAGS
|
|
453
|
-
-c, --cwd=<value>
|
|
454
|
-
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
894
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
895
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
896
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
897
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
898
|
+
-m, --message=<value> A short summary of why this deploys.
|
|
899
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
900
|
+
an agent.
|
|
901
|
+
-s, --server=<value> Override the resolved server URL.
|
|
902
|
+
-v, --verbose Verbose logging.
|
|
903
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
904
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
905
|
+
--debug Debug logging.
|
|
906
|
+
--dry-run Preview without mutating files or the platform.
|
|
907
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
908
|
+
process environment. Cannot be combined with --env.
|
|
909
|
+
--release=<value> (required) The release id to deploy.
|
|
910
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
911
|
+
--no-telemetry.
|
|
460
912
|
|
|
461
913
|
GLOBAL FLAGS
|
|
462
914
|
--json Format output as json.
|
|
463
915
|
|
|
464
916
|
DESCRIPTION
|
|
465
|
-
|
|
917
|
+
Deploy an existing release to the project's origins.
|
|
918
|
+
|
|
919
|
+
EXAMPLES
|
|
920
|
+
$ zitadel deployment create --release rel_01KX3RG8A7F0N9WD3P2E4YM5C1
|
|
466
921
|
```
|
|
467
922
|
|
|
468
|
-
## `zitadel
|
|
923
|
+
## `zitadel deployment get DEPLOYMENT_ID`
|
|
469
924
|
|
|
470
|
-
|
|
925
|
+
Read one deployment by id.
|
|
471
926
|
|
|
472
927
|
```
|
|
473
928
|
USAGE
|
|
474
|
-
$ zitadel
|
|
929
|
+
$ zitadel deployment get DEPLOYMENT_ID [--json] [-c <value>] [-s <value>]
|
|
930
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
|
|
931
|
+
[--env-file <value>]
|
|
932
|
+
|
|
933
|
+
ARGUMENTS
|
|
934
|
+
DEPLOYMENT_ID The deployment to read.
|
|
475
935
|
|
|
476
936
|
FLAGS
|
|
477
|
-
-c, --cwd=<value>
|
|
478
|
-
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
937
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
938
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
939
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
940
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
941
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
942
|
+
an agent.
|
|
943
|
+
-s, --server=<value> Override the resolved server URL.
|
|
944
|
+
-v, --verbose Verbose logging.
|
|
945
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
946
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
947
|
+
--debug Debug logging.
|
|
948
|
+
--dry-run Preview without mutating files or the platform.
|
|
949
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
950
|
+
process environment. Cannot be combined with --env.
|
|
951
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
952
|
+
--no-telemetry.
|
|
484
953
|
|
|
485
954
|
GLOBAL FLAGS
|
|
486
955
|
--json Format output as json.
|
|
487
956
|
|
|
488
957
|
DESCRIPTION
|
|
489
|
-
|
|
958
|
+
Read one deployment by id.
|
|
490
959
|
|
|
491
|
-
|
|
492
|
-
$ zitadel
|
|
960
|
+
EXAMPLES
|
|
961
|
+
$ zitadel deployment get dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
|
|
962
|
+
```
|
|
963
|
+
|
|
964
|
+
## `zitadel deployment list`
|
|
965
|
+
|
|
966
|
+
List the project's deployments, newest first.
|
|
967
|
+
|
|
968
|
+
```
|
|
969
|
+
USAGE
|
|
970
|
+
$ zitadel deployment list [--json] [-c <value>] [-s <value>] [-n]
|
|
971
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
972
|
+
<value>] [--origin <value>] [--live] [--limit <value>] [-a | --page-token
|
|
973
|
+
<value>] [--plain]
|
|
974
|
+
|
|
975
|
+
FLAGS
|
|
976
|
+
-a, --all Fetch every page instead of one.
|
|
977
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
978
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
979
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
980
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
981
|
+
development.
|
|
982
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
983
|
+
as an agent.
|
|
984
|
+
-s, --server=<value> Override the resolved server URL.
|
|
985
|
+
-v, --verbose Verbose logging.
|
|
986
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
987
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
988
|
+
--debug Debug logging.
|
|
989
|
+
--dry-run Preview without mutating files or the platform.
|
|
990
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
991
|
+
process environment. Cannot be combined with --env.
|
|
992
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
993
|
+
--live What each target serves now, not the full history.
|
|
994
|
+
--origin=<value> Only deployments that targeted this origin.
|
|
995
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
996
|
+
--plain Tab-separated rows with no header, for piping.
|
|
997
|
+
Implied when stdout is not a terminal.
|
|
998
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
999
|
+
--no-telemetry.
|
|
1000
|
+
|
|
1001
|
+
GLOBAL FLAGS
|
|
1002
|
+
--json Format output as json.
|
|
1003
|
+
|
|
1004
|
+
DESCRIPTION
|
|
1005
|
+
List the project's deployments, newest first.
|
|
1006
|
+
|
|
1007
|
+
EXAMPLES
|
|
1008
|
+
$ zitadel deployment list
|
|
1009
|
+
|
|
1010
|
+
$ zitadel deployment list --all
|
|
1011
|
+
|
|
1012
|
+
$ zitadel deployment list --live
|
|
1013
|
+
|
|
1014
|
+
$ zitadel deployment list --origin https://app.acme.com
|
|
1015
|
+
```
|
|
1016
|
+
|
|
1017
|
+
## `zitadel deployment rollback [DEPLOYMENT_ID]`
|
|
1018
|
+
|
|
1019
|
+
Roll back to an earlier deployment.
|
|
1020
|
+
|
|
1021
|
+
```
|
|
1022
|
+
USAGE
|
|
1023
|
+
$ zitadel deployment rollback [DEPLOYMENT_ID] [--json] [-c <value>] [-s
|
|
1024
|
+
<value>] [-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e
|
|
1025
|
+
<value>] [--env-file <value>] [-f]
|
|
1026
|
+
|
|
1027
|
+
ARGUMENTS
|
|
1028
|
+
[DEPLOYMENT_ID] The deployment to re-apply. Omit to undo the last deploy.
|
|
1029
|
+
|
|
1030
|
+
FLAGS
|
|
1031
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1032
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1033
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1034
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1035
|
+
-f, --force Roll back without the confirmation prompt. Required
|
|
1036
|
+
when non-interactive.
|
|
1037
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1038
|
+
an agent.
|
|
1039
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1040
|
+
-v, --verbose Verbose logging.
|
|
1041
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1042
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1043
|
+
--debug Debug logging.
|
|
1044
|
+
--dry-run Preview without mutating files or the platform.
|
|
1045
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1046
|
+
process environment. Cannot be combined with --env.
|
|
1047
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1048
|
+
--no-telemetry.
|
|
1049
|
+
|
|
1050
|
+
GLOBAL FLAGS
|
|
1051
|
+
--json Format output as json.
|
|
1052
|
+
|
|
1053
|
+
DESCRIPTION
|
|
1054
|
+
Roll back to an earlier deployment.
|
|
1055
|
+
|
|
1056
|
+
EXAMPLES
|
|
1057
|
+
$ zitadel deployment rollback
|
|
1058
|
+
|
|
1059
|
+
$ zitadel deployment rollback dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
|
|
1060
|
+
|
|
1061
|
+
$ zitadel deployment rollback --force
|
|
1062
|
+
```
|
|
1063
|
+
|
|
1064
|
+
## `zitadel doctor`
|
|
1065
|
+
|
|
1066
|
+
Verify local runtime and project state.
|
|
1067
|
+
|
|
1068
|
+
```
|
|
1069
|
+
USAGE
|
|
1070
|
+
$ zitadel doctor [--json] [-c <value>] [-s <value>] [-n]
|
|
1071
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--fix] [--image <value>]
|
|
1072
|
+
[--port <value>] [--runtime binary|docker] [-e <value>] [--env-file <value>]
|
|
1073
|
+
|
|
1074
|
+
FLAGS
|
|
1075
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1076
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1077
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1078
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1079
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1080
|
+
an agent.
|
|
1081
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1082
|
+
-v, --verbose Verbose logging.
|
|
1083
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1084
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1085
|
+
--debug Debug logging.
|
|
1086
|
+
--dry-run Preview without mutating files or the platform.
|
|
1087
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1088
|
+
process environment. Cannot be combined with --env.
|
|
1089
|
+
--fix Repair missing files and stale managed wiring.
|
|
1090
|
+
--image=<value> Container image to check.
|
|
1091
|
+
--port=<value> Local HTTP port to check. Defaults to the port this
|
|
1092
|
+
directory's server uses.
|
|
1093
|
+
--runtime=<option> Local runtime backend.
|
|
1094
|
+
<options: binary|docker>
|
|
1095
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1096
|
+
--no-telemetry.
|
|
1097
|
+
|
|
1098
|
+
GLOBAL FLAGS
|
|
1099
|
+
--json Format output as json.
|
|
1100
|
+
|
|
1101
|
+
DESCRIPTION
|
|
1102
|
+
Verify local runtime and project state.
|
|
1103
|
+
```
|
|
1104
|
+
|
|
1105
|
+
## `zitadel eject`
|
|
1106
|
+
|
|
1107
|
+
Remove managed files and local Zitadel state.
|
|
1108
|
+
|
|
1109
|
+
```
|
|
1110
|
+
USAGE
|
|
1111
|
+
$ zitadel eject [--json] [-c <value>] [-s <value>] [-n]
|
|
1112
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
1113
|
+
|
|
1114
|
+
FLAGS
|
|
1115
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1116
|
+
-f, --force Remove the managed files without the confirmation
|
|
1117
|
+
prompt.
|
|
1118
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1119
|
+
an agent.
|
|
1120
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1121
|
+
-v, --verbose Verbose logging.
|
|
1122
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1123
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1124
|
+
--debug Debug logging.
|
|
1125
|
+
--dry-run Preview without mutating files or the platform.
|
|
1126
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1127
|
+
--no-telemetry.
|
|
1128
|
+
|
|
1129
|
+
GLOBAL FLAGS
|
|
1130
|
+
--json Format output as json.
|
|
1131
|
+
|
|
1132
|
+
DESCRIPTION
|
|
1133
|
+
Remove managed files and local Zitadel state.
|
|
1134
|
+
|
|
1135
|
+
ALIASES
|
|
1136
|
+
$ zitadel uninstall
|
|
1137
|
+
```
|
|
1138
|
+
|
|
1139
|
+
## `zitadel env`
|
|
1140
|
+
|
|
1141
|
+
Show which server and project resolve, and where each value came from.
|
|
1142
|
+
|
|
1143
|
+
```
|
|
1144
|
+
USAGE
|
|
1145
|
+
$ zitadel env [--json] [-c <value>] [-s <value>] [-n]
|
|
1146
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1147
|
+
<value>]
|
|
1148
|
+
|
|
1149
|
+
FLAGS
|
|
1150
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1151
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1152
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1153
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1154
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1155
|
+
an agent.
|
|
1156
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1157
|
+
-v, --verbose Verbose logging.
|
|
1158
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1159
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1160
|
+
--debug Debug logging.
|
|
1161
|
+
--dry-run Preview without mutating files or the platform.
|
|
1162
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1163
|
+
process environment. Cannot be combined with --env.
|
|
1164
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1165
|
+
--no-telemetry.
|
|
1166
|
+
|
|
1167
|
+
GLOBAL FLAGS
|
|
1168
|
+
--json Format output as json.
|
|
1169
|
+
|
|
1170
|
+
DESCRIPTION
|
|
1171
|
+
Show which server and project resolve, and where each value came from.
|
|
1172
|
+
|
|
1173
|
+
EXAMPLES
|
|
1174
|
+
$ zitadel env
|
|
1175
|
+
|
|
1176
|
+
$ zitadel env --env production
|
|
1177
|
+
|
|
1178
|
+
$ zitadel env --env-file ./infra/acme-staging.env
|
|
1179
|
+
```
|
|
1180
|
+
|
|
1181
|
+
## `zitadel env add NAME`
|
|
1182
|
+
|
|
1183
|
+
Bind an environment to a project, creating the project if needed.
|
|
1184
|
+
|
|
1185
|
+
```
|
|
1186
|
+
USAGE
|
|
1187
|
+
$ zitadel env add NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
1188
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--project <value>]
|
|
1189
|
+
[--app-url <value>] [--force]
|
|
1190
|
+
|
|
1191
|
+
ARGUMENTS
|
|
1192
|
+
NAME The environment name, e.g. production.
|
|
1193
|
+
|
|
1194
|
+
FLAGS
|
|
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
|
+
-v, --verbose Verbose logging.
|
|
1200
|
+
--app-url=<value> The URL this environment's app is served from. It
|
|
1201
|
+
becomes ZITADEL_ISSUER and is registered with a new
|
|
1202
|
+
project.
|
|
1203
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1204
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1205
|
+
--debug Debug logging.
|
|
1206
|
+
--dry-run Preview without mutating files or the platform.
|
|
1207
|
+
--force Overwrite an existing .env.<name>.local.
|
|
1208
|
+
--project=<value> Bind this existing project instead of creating one. Its
|
|
1209
|
+
secrets come from ZITADEL_PROJECT_SECRET and
|
|
1210
|
+
ZITADEL_PREVIEW_TOKEN in the process environment.
|
|
1211
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1212
|
+
--no-telemetry.
|
|
1213
|
+
|
|
1214
|
+
GLOBAL FLAGS
|
|
1215
|
+
--json Format output as json.
|
|
1216
|
+
|
|
1217
|
+
DESCRIPTION
|
|
1218
|
+
Bind an environment to a project, creating the project if needed.
|
|
1219
|
+
|
|
1220
|
+
EXAMPLES
|
|
1221
|
+
$ zitadel env add production --server https://api.zitadel.cloud --app-url https://app.acme.com
|
|
1222
|
+
|
|
1223
|
+
$ zitadel env add staging --server https://api.zitadel.cloud --project proj_01K9AA9M3K7E2QX8VB4T
|
|
1224
|
+
```
|
|
1225
|
+
|
|
1226
|
+
## `zitadel env list`
|
|
1227
|
+
|
|
1228
|
+
List the environments bound in this directory's .env files.
|
|
1229
|
+
|
|
1230
|
+
```
|
|
1231
|
+
USAGE
|
|
1232
|
+
$ zitadel env list [--json] [-c <value>] [-s <value>] [-n]
|
|
1233
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1234
|
+
<value>] [--plain]
|
|
1235
|
+
|
|
1236
|
+
FLAGS
|
|
1237
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1238
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1239
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1240
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1241
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1242
|
+
an agent.
|
|
1243
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1244
|
+
-v, --verbose Verbose logging.
|
|
1245
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1246
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1247
|
+
--debug Debug logging.
|
|
1248
|
+
--dry-run Preview without mutating files or the platform.
|
|
1249
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1250
|
+
process environment. Cannot be combined with --env.
|
|
1251
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
1252
|
+
when stdout is not a terminal.
|
|
1253
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1254
|
+
--no-telemetry.
|
|
1255
|
+
|
|
1256
|
+
GLOBAL FLAGS
|
|
1257
|
+
--json Format output as json.
|
|
1258
|
+
|
|
1259
|
+
DESCRIPTION
|
|
1260
|
+
List the environments bound in this directory's .env files.
|
|
1261
|
+
|
|
1262
|
+
EXAMPLES
|
|
1263
|
+
$ zitadel env list
|
|
1264
|
+
|
|
1265
|
+
$ zitadel env list --plain
|
|
1266
|
+
```
|
|
1267
|
+
|
|
1268
|
+
## `zitadel events get ID`
|
|
1269
|
+
|
|
1270
|
+
Get one event by id.
|
|
1271
|
+
|
|
1272
|
+
```
|
|
1273
|
+
USAGE
|
|
1274
|
+
$ zitadel events get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1275
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1276
|
+
<value>] [--fields <value>]
|
|
1277
|
+
|
|
1278
|
+
ARGUMENTS
|
|
1279
|
+
ID event id
|
|
1280
|
+
|
|
1281
|
+
FLAGS
|
|
1282
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1283
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1284
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1285
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1286
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1287
|
+
an agent.
|
|
1288
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1289
|
+
-v, --verbose Verbose logging.
|
|
1290
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1291
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1292
|
+
--debug Debug logging.
|
|
1293
|
+
--dry-run Preview without mutating files or the platform.
|
|
1294
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1295
|
+
process environment. Cannot be combined with --env.
|
|
1296
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1297
|
+
the resource's own; `--json` is unaffected.
|
|
1298
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1299
|
+
--no-telemetry.
|
|
1300
|
+
|
|
1301
|
+
GLOBAL FLAGS
|
|
1302
|
+
--json Format output as json.
|
|
1303
|
+
|
|
1304
|
+
DESCRIPTION
|
|
1305
|
+
Get one event by id.
|
|
1306
|
+
|
|
1307
|
+
EXAMPLES
|
|
1308
|
+
$ zitadel events get <id>
|
|
1309
|
+
|
|
1310
|
+
$ zitadel events get <id> --json
|
|
1311
|
+
```
|
|
1312
|
+
|
|
1313
|
+
## `zitadel events list`
|
|
1314
|
+
|
|
1315
|
+
List events.
|
|
1316
|
+
|
|
1317
|
+
```
|
|
1318
|
+
USAGE
|
|
1319
|
+
$ zitadel events list [--json] [-c <value>] [-s <value>] [-n]
|
|
1320
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1321
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1322
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1323
|
+
|
|
1324
|
+
FLAGS
|
|
1325
|
+
-a, --all
|
|
1326
|
+
Fetch every page instead of one.
|
|
1327
|
+
|
|
1328
|
+
-c, --cwd=<value>
|
|
1329
|
+
Project directory to operate on.
|
|
1330
|
+
|
|
1331
|
+
-e, --env=<value>
|
|
1332
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
1333
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1334
|
+
development.
|
|
1335
|
+
|
|
1336
|
+
-n, --non-interactive
|
|
1337
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
1338
|
+
|
|
1339
|
+
-s, --server=<value>
|
|
1340
|
+
Override the resolved server URL.
|
|
1341
|
+
|
|
1342
|
+
-v, --verbose
|
|
1343
|
+
Verbose logging.
|
|
1344
|
+
|
|
1345
|
+
--[no-]color
|
|
1346
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1347
|
+
honored too.
|
|
1348
|
+
|
|
1349
|
+
--debug
|
|
1350
|
+
Debug logging.
|
|
1351
|
+
|
|
1352
|
+
--dry-run
|
|
1353
|
+
Preview without mutating files or the platform.
|
|
1354
|
+
|
|
1355
|
+
--env-file=<value>
|
|
1356
|
+
Read ZITADEL_* values from this file ahead of the process environment.
|
|
1357
|
+
Cannot be combined with --env.
|
|
1358
|
+
|
|
1359
|
+
--fields=<value>
|
|
1360
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
1361
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
1362
|
+
|
|
1363
|
+
--filter=<value>...
|
|
1364
|
+
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
1365
|
+
category (equals; values request|auth|session|admin|entity|signal; repeats
|
|
1366
|
+
widen), event_type (equals; repeats widen), actor_id (equals), session_id
|
|
1367
|
+
(equals), flow_id (equals), request_id (equals), entity_type (equals),
|
|
1368
|
+
entity_id (equals), team_id (equals), created_at
|
|
1369
|
+
(greater_than_or_equal|less_than).
|
|
1370
|
+
|
|
1371
|
+
--limit=<value>
|
|
1372
|
+
Page size (server default 20, max 100).
|
|
1373
|
+
|
|
1374
|
+
--page-token=<value>
|
|
1375
|
+
Continue from a previous page's next_page_token.
|
|
1376
|
+
|
|
1377
|
+
--plain
|
|
1378
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
1379
|
+
terminal.
|
|
1380
|
+
|
|
1381
|
+
--sort=<value>
|
|
1382
|
+
Sort as field:direction (asc|desc). Fields: occurred_at.
|
|
1383
|
+
|
|
1384
|
+
--[no-]telemetry
|
|
1385
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1386
|
+
|
|
1387
|
+
GLOBAL FLAGS
|
|
1388
|
+
--json Format output as json.
|
|
1389
|
+
|
|
1390
|
+
DESCRIPTION
|
|
1391
|
+
List events.
|
|
1392
|
+
|
|
1393
|
+
EXAMPLES
|
|
1394
|
+
$ zitadel events list --json
|
|
1395
|
+
|
|
1396
|
+
$ zitadel events list --all --json
|
|
1397
|
+
|
|
1398
|
+
$ zitadel events list --filter category=equals:<value> --sort occurred_at:desc
|
|
1399
|
+
```
|
|
1400
|
+
|
|
1401
|
+
## `zitadel flow-definitions get FLOW`
|
|
1402
|
+
|
|
1403
|
+
Get one flow definition by flow name (newest revision) or revision id.
|
|
1404
|
+
|
|
1405
|
+
```
|
|
1406
|
+
USAGE
|
|
1407
|
+
$ zitadel flow-definitions get FLOW [--json] [-c <value>] [-s <value>] [-n]
|
|
1408
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1409
|
+
<value>] [--fields <value>]
|
|
1410
|
+
|
|
1411
|
+
ARGUMENTS
|
|
1412
|
+
FLOW flow name (newest revision) or revision id
|
|
1413
|
+
|
|
1414
|
+
FLAGS
|
|
1415
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1416
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1417
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1418
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1419
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1420
|
+
an agent.
|
|
1421
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1422
|
+
-v, --verbose Verbose logging.
|
|
1423
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1424
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1425
|
+
--debug Debug logging.
|
|
1426
|
+
--dry-run Preview without mutating files or the platform.
|
|
1427
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1428
|
+
process environment. Cannot be combined with --env.
|
|
1429
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1430
|
+
the resource's own; `--json` is unaffected.
|
|
1431
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1432
|
+
--no-telemetry.
|
|
1433
|
+
|
|
1434
|
+
GLOBAL FLAGS
|
|
1435
|
+
--json Format output as json.
|
|
1436
|
+
|
|
1437
|
+
DESCRIPTION
|
|
1438
|
+
Get one flow definition by flow name (newest revision) or revision id.
|
|
1439
|
+
|
|
1440
|
+
EXAMPLES
|
|
1441
|
+
$ zitadel flow-definitions get <flow>
|
|
1442
|
+
|
|
1443
|
+
$ zitadel flow-definitions get <flow> --json
|
|
1444
|
+
```
|
|
1445
|
+
|
|
1446
|
+
## `zitadel flow-definitions list`
|
|
1447
|
+
|
|
1448
|
+
List flow-definitions.
|
|
1449
|
+
|
|
1450
|
+
```
|
|
1451
|
+
USAGE
|
|
1452
|
+
$ zitadel flow-definitions list [--json] [-c <value>] [-s <value>] [-n]
|
|
1453
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1454
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1455
|
+
[--plain] [--filter <value>...]
|
|
1456
|
+
|
|
1457
|
+
FLAGS
|
|
1458
|
+
-a, --all Fetch every page instead of one.
|
|
1459
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1460
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
1461
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
1462
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1463
|
+
development.
|
|
1464
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
1465
|
+
as an agent.
|
|
1466
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1467
|
+
-v, --verbose Verbose logging.
|
|
1468
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1469
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1470
|
+
--debug Debug logging.
|
|
1471
|
+
--dry-run Preview without mutating files or the platform.
|
|
1472
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1473
|
+
process environment. Cannot be combined with --env.
|
|
1474
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
1475
|
+
id,attributes.email). Defaults to the resource's own
|
|
1476
|
+
columns; `--json` is unaffected.
|
|
1477
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
1478
|
+
to equals). Fields: name (equals), purpose (equals),
|
|
1479
|
+
revisions (equals; values all|latest).
|
|
1480
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
1481
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
1482
|
+
--plain Tab-separated rows with no header, for piping.
|
|
1483
|
+
Implied when stdout is not a terminal.
|
|
1484
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1485
|
+
--no-telemetry.
|
|
1486
|
+
|
|
1487
|
+
GLOBAL FLAGS
|
|
1488
|
+
--json Format output as json.
|
|
1489
|
+
|
|
1490
|
+
DESCRIPTION
|
|
1491
|
+
List flow-definitions.
|
|
1492
|
+
|
|
1493
|
+
EXAMPLES
|
|
1494
|
+
$ zitadel flow-definitions list --json
|
|
1495
|
+
|
|
1496
|
+
$ zitadel flow-definitions list --all --json
|
|
1497
|
+
|
|
1498
|
+
$ zitadel flow-definitions list --filter name=equals:<value>
|
|
1499
|
+
```
|
|
1500
|
+
|
|
1501
|
+
## `zitadel grants create`
|
|
1502
|
+
|
|
1503
|
+
Create a grant.
|
|
1504
|
+
|
|
1505
|
+
```
|
|
1506
|
+
USAGE
|
|
1507
|
+
$ zitadel grants create [--json] [-c <value>] [-s <value>] [-n]
|
|
1508
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1509
|
+
<value>] [--relation viewer|editor|admin] [--expires-at <value>]
|
|
1510
|
+
[--user-user-id <value>] [--user-identifier <value>] [--team-team-id
|
|
1511
|
+
<value>] [--team-name <value>] [--data <value> | --file <value>] [--set
|
|
1512
|
+
<value>...]
|
|
1513
|
+
|
|
1514
|
+
FLAGS
|
|
1515
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1516
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1517
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1518
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1519
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1520
|
+
an agent.
|
|
1521
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1522
|
+
-v, --verbose Verbose logging.
|
|
1523
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1524
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1525
|
+
--debug Debug logging.
|
|
1526
|
+
--dry-run Preview without mutating files or the platform.
|
|
1527
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1528
|
+
process environment. Cannot be combined with --env.
|
|
1529
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1530
|
+
--no-telemetry.
|
|
1531
|
+
|
|
1532
|
+
RAW BODY FLAGS
|
|
1533
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
1534
|
+
over it.
|
|
1535
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
1536
|
+
and --set apply over it.
|
|
1537
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
1538
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
1539
|
+
key that contains a dot is set through its parent: --set
|
|
1540
|
+
'parent:={"a.b":"x"}'.
|
|
1541
|
+
|
|
1542
|
+
OPTIONAL FIELD FLAGS
|
|
1543
|
+
--expires-at=<value> Optional expiry.
|
|
1544
|
+
|
|
1545
|
+
GLOBAL FLAGS
|
|
1546
|
+
--json Format output as json.
|
|
1547
|
+
|
|
1548
|
+
REQUIRED FIELD FLAGS
|
|
1549
|
+
--relation=<option> (required) Catalog relation on `object_type` `project`.
|
|
1550
|
+
<options: viewer|editor|admin>
|
|
1551
|
+
|
|
1552
|
+
TEAM FIELD FLAGS
|
|
1553
|
+
--team-name=<value> Team name, unique per project case-insensitively.
|
|
1554
|
+
--team-team-id=<value>
|
|
1555
|
+
|
|
1556
|
+
USER FIELD FLAGS
|
|
1557
|
+
--user-identifier=<value> The user schema's designated identifier
|
|
1558
|
+
(`x-identifier`), looked up in the platform
|
|
1559
|
+
project.
|
|
1560
|
+
--user-user-id=<value>
|
|
1561
|
+
|
|
1562
|
+
DESCRIPTION
|
|
1563
|
+
Create a grant.
|
|
1564
|
+
|
|
1565
|
+
EXAMPLES
|
|
1566
|
+
$ zitadel grants create --relation viewer --user-identifier alice@acme.com --json
|
|
1567
|
+
|
|
1568
|
+
$ zitadel grants create --data '{...}' --json
|
|
1569
|
+
|
|
1570
|
+
$ zitadel grants create --file ./grant.json
|
|
1571
|
+
```
|
|
1572
|
+
|
|
1573
|
+
## `zitadel grants delete ID`
|
|
1574
|
+
|
|
1575
|
+
Delete a grant by id.
|
|
1576
|
+
|
|
1577
|
+
```
|
|
1578
|
+
USAGE
|
|
1579
|
+
$ zitadel grants delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1580
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1581
|
+
<value>] [-f]
|
|
1582
|
+
|
|
1583
|
+
ARGUMENTS
|
|
1584
|
+
ID grant id
|
|
1585
|
+
|
|
1586
|
+
FLAGS
|
|
1587
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1588
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1589
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1590
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1591
|
+
-f, --force Delete the grant without the confirmation prompt.
|
|
1592
|
+
Required when non-interactive.
|
|
1593
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1594
|
+
an agent.
|
|
1595
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1596
|
+
-v, --verbose Verbose logging.
|
|
1597
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1598
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1599
|
+
--debug Debug logging.
|
|
1600
|
+
--dry-run Preview without mutating files or the platform.
|
|
1601
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1602
|
+
process environment. Cannot be combined with --env.
|
|
1603
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1604
|
+
--no-telemetry.
|
|
1605
|
+
|
|
1606
|
+
GLOBAL FLAGS
|
|
1607
|
+
--json Format output as json.
|
|
1608
|
+
|
|
1609
|
+
DESCRIPTION
|
|
1610
|
+
Delete a grant by id.
|
|
1611
|
+
|
|
1612
|
+
EXAMPLES
|
|
1613
|
+
$ zitadel grants delete <id> --force --json
|
|
1614
|
+
```
|
|
1615
|
+
|
|
1616
|
+
## `zitadel grants get ID`
|
|
1617
|
+
|
|
1618
|
+
Get one grant by id.
|
|
1619
|
+
|
|
1620
|
+
```
|
|
1621
|
+
USAGE
|
|
1622
|
+
$ zitadel grants get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1623
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1624
|
+
<value>] [--fields <value>]
|
|
1625
|
+
|
|
1626
|
+
ARGUMENTS
|
|
1627
|
+
ID grant id
|
|
1628
|
+
|
|
1629
|
+
FLAGS
|
|
1630
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1631
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1632
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1633
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1634
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1635
|
+
an agent.
|
|
1636
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1637
|
+
-v, --verbose Verbose logging.
|
|
1638
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1639
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1640
|
+
--debug Debug logging.
|
|
1641
|
+
--dry-run Preview without mutating files or the platform.
|
|
1642
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1643
|
+
process environment. Cannot be combined with --env.
|
|
1644
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1645
|
+
the resource's own; `--json` is unaffected.
|
|
1646
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1647
|
+
--no-telemetry.
|
|
1648
|
+
|
|
1649
|
+
GLOBAL FLAGS
|
|
1650
|
+
--json Format output as json.
|
|
1651
|
+
|
|
1652
|
+
DESCRIPTION
|
|
1653
|
+
Get one grant by id.
|
|
1654
|
+
|
|
1655
|
+
EXAMPLES
|
|
1656
|
+
$ zitadel grants get <id>
|
|
1657
|
+
|
|
1658
|
+
$ zitadel grants get <id> --json
|
|
1659
|
+
```
|
|
1660
|
+
|
|
1661
|
+
## `zitadel grants list`
|
|
1662
|
+
|
|
1663
|
+
List grants.
|
|
1664
|
+
|
|
1665
|
+
```
|
|
1666
|
+
USAGE
|
|
1667
|
+
$ zitadel grants list [--json] [-c <value>] [-s <value>] [-n]
|
|
1668
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1669
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1670
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1671
|
+
|
|
1672
|
+
FLAGS
|
|
1673
|
+
-a, --all
|
|
1674
|
+
Fetch every page instead of one.
|
|
1675
|
+
|
|
1676
|
+
-c, --cwd=<value>
|
|
1677
|
+
Project directory to operate on.
|
|
1678
|
+
|
|
1679
|
+
-e, --env=<value>
|
|
1680
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
1681
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1682
|
+
development.
|
|
1683
|
+
|
|
1684
|
+
-n, --non-interactive
|
|
1685
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
1686
|
+
|
|
1687
|
+
-s, --server=<value>
|
|
1688
|
+
Override the resolved server URL.
|
|
1689
|
+
|
|
1690
|
+
-v, --verbose
|
|
1691
|
+
Verbose logging.
|
|
1692
|
+
|
|
1693
|
+
--[no-]color
|
|
1694
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1695
|
+
honored too.
|
|
1696
|
+
|
|
1697
|
+
--debug
|
|
1698
|
+
Debug logging.
|
|
1699
|
+
|
|
1700
|
+
--dry-run
|
|
1701
|
+
Preview without mutating files or the platform.
|
|
1702
|
+
|
|
1703
|
+
--env-file=<value>
|
|
1704
|
+
Read ZITADEL_* values from this file ahead of the process environment.
|
|
1705
|
+
Cannot be combined with --env.
|
|
1706
|
+
|
|
1707
|
+
--fields=<value>
|
|
1708
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
1709
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
1710
|
+
|
|
1711
|
+
--filter=<value>...
|
|
1712
|
+
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
1713
|
+
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
1714
|
+
qual|greater_than|greater_than_or_equal), user_id
|
|
1715
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
1716
|
+
r_than|greater_than_or_equal), team_id (equals|not_equals|contains|not_conta
|
|
1717
|
+
ins|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
1718
|
+
relation (equals|not_equals|contains|not_contains|less_than|less_than_or_equ
|
|
1719
|
+
al|greater_than|greater_than_or_equal), expires_at
|
|
1720
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
1721
|
+
r_than|greater_than_or_equal).
|
|
1722
|
+
|
|
1723
|
+
--limit=<value>
|
|
1724
|
+
Page size (server default 20, max 100).
|
|
1725
|
+
|
|
1726
|
+
--page-token=<value>
|
|
1727
|
+
Continue from a previous page's next_page_token.
|
|
1728
|
+
|
|
1729
|
+
--plain
|
|
1730
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
1731
|
+
terminal.
|
|
1732
|
+
|
|
1733
|
+
--sort=<value>
|
|
1734
|
+
Sort as field:direction (asc|desc). Fields: created_at, expires_at, id.
|
|
1735
|
+
|
|
1736
|
+
--[no-]telemetry
|
|
1737
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
1738
|
+
|
|
1739
|
+
GLOBAL FLAGS
|
|
1740
|
+
--json Format output as json.
|
|
1741
|
+
|
|
1742
|
+
DESCRIPTION
|
|
1743
|
+
List grants.
|
|
1744
|
+
|
|
1745
|
+
EXAMPLES
|
|
1746
|
+
$ zitadel grants list --json
|
|
1747
|
+
|
|
1748
|
+
$ zitadel grants list --all --json
|
|
1749
|
+
|
|
1750
|
+
$ zitadel grants list --filter created_at=equals:<value> --sort created_at:desc
|
|
1751
|
+
```
|
|
1752
|
+
|
|
1753
|
+
## `zitadel help [COMMAND]`
|
|
1754
|
+
|
|
1755
|
+
Display help for zitadel.
|
|
1756
|
+
|
|
1757
|
+
```
|
|
1758
|
+
USAGE
|
|
1759
|
+
$ zitadel help [COMMAND...] [-n]
|
|
1760
|
+
|
|
1761
|
+
ARGUMENTS
|
|
1762
|
+
[COMMAND...] Command to show help for.
|
|
1763
|
+
|
|
1764
|
+
FLAGS
|
|
1765
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
1766
|
+
|
|
1767
|
+
DESCRIPTION
|
|
1768
|
+
Display help for zitadel.
|
|
1769
|
+
```
|
|
1770
|
+
|
|
1771
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.49/src/commands/help.ts)_
|
|
1772
|
+
|
|
1773
|
+
## `zitadel idps create`
|
|
1774
|
+
|
|
1775
|
+
Create an identity provider connection.
|
|
1776
|
+
|
|
1777
|
+
```
|
|
1778
|
+
USAGE
|
|
1779
|
+
$ zitadel idps create [--json] [-c <value>] [-s <value>] [-n]
|
|
1780
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1781
|
+
<value>] [--slug <value>] [--protocol oidc] [--template <value>]
|
|
1782
|
+
[--display-name <value>] [--subject-claim <value>] [--claim-mapping
|
|
1783
|
+
<value>...] [--verified-claims <value>...] [--provisioning-creation
|
|
1784
|
+
disabled|auto] [--oidc-issuer <value>] [--oidc-jwks-uri <value>]
|
|
1785
|
+
[--oidc-id-token-mapping] [--oidc-authorization-endpoint <value>]
|
|
1786
|
+
[--oidc-token-endpoint <value>] [--oidc-userinfo-endpoint <value>]
|
|
1787
|
+
[--oidc-client-id <value>] [--oidc-client-secret <value>]
|
|
1788
|
+
[--oidc-token-endpoint-auth-method client_secret_basic|client_secret_post]
|
|
1789
|
+
[--oidc-scopes <value>...] [--oidc-pkce-enabled]
|
|
1790
|
+
[--oidc-static-authorize-parameters <value>...] [--data <value> | --file
|
|
1791
|
+
<value>] [--set <value>...]
|
|
1792
|
+
|
|
1793
|
+
FLAGS
|
|
1794
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1795
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1796
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1797
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1798
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1799
|
+
an agent.
|
|
1800
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1801
|
+
-v, --verbose Verbose logging.
|
|
1802
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1803
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1804
|
+
--debug Debug logging.
|
|
1805
|
+
--dry-run Preview without mutating files or the platform.
|
|
1806
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1807
|
+
process environment. Cannot be combined with --env.
|
|
1808
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1809
|
+
--no-telemetry.
|
|
1810
|
+
|
|
1811
|
+
OPTIONAL FIELD FLAGS
|
|
1812
|
+
--claim-mapping=<value>... Repeatable claim_mapping entry: key=value for a
|
|
1813
|
+
string, key:=value for JSON. Maps user-schema
|
|
1814
|
+
property names (keys) to provider claim names
|
|
1815
|
+
(values).
|
|
1816
|
+
--subject-claim=<value> Claim carrying the provider's stable subject
|
|
1817
|
+
identifier.
|
|
1818
|
+
--template=<value> Template hint for rendering the provider (logo,
|
|
1819
|
+
colors).
|
|
1820
|
+
--verified-claims=<value>... Repeatable verified_claims entry: key=value for
|
|
1821
|
+
a string, key:=value for JSON. Maps a verifiable
|
|
1822
|
+
user-schema property to its verification source:
|
|
1823
|
+
a claim name (read the claim) or the…
|
|
1824
|
+
|
|
1825
|
+
RAW BODY FLAGS
|
|
1826
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
1827
|
+
over it.
|
|
1828
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
1829
|
+
and --set apply over it.
|
|
1830
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
1831
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
1832
|
+
key that contains a dot is set through its parent: --set
|
|
1833
|
+
'parent:={"a.b":"x"}'.
|
|
1834
|
+
|
|
1835
|
+
REQUIRED FIELD FLAGS
|
|
1836
|
+
--display-name=<value> (required) Shown to the user on the sign-in button.
|
|
1837
|
+
--protocol=<option> (required) The protocol used by the identity provider.
|
|
1838
|
+
<options: oidc>
|
|
1839
|
+
--slug=<value> (required) Stable identifier, referenced by user
|
|
1840
|
+
schemas (x-auth-methods.sso.providers) and flow steps
|
|
1841
|
+
(sso_providers).
|
|
1842
|
+
|
|
1843
|
+
GLOBAL FLAGS
|
|
1844
|
+
--json Format output as json.
|
|
1845
|
+
|
|
1846
|
+
OIDC FIELD FLAGS
|
|
1847
|
+
--oidc-authorization-endpoint=<value>
|
|
1848
|
+
For a provider that exposes no .well-known document.
|
|
1849
|
+
|
|
1850
|
+
--oidc-client-id=<value>
|
|
1851
|
+
(required with oidc.*) Either a literal in case the same client is used in
|
|
1852
|
+
all environments, or a `${{ NAME }}` reference to a…
|
|
1853
|
+
|
|
1854
|
+
--oidc-client-secret=<value>
|
|
1855
|
+
(required with oidc.*) A reference to the variable holding the client
|
|
1856
|
+
secret, never the secret itself.
|
|
1857
|
+
|
|
1858
|
+
--[no-]oidc-id-token-mapping
|
|
1859
|
+
Read user claims from the id_token instead of the userinfo endpoint, for
|
|
1860
|
+
providers that populate only the…
|
|
1861
|
+
|
|
1862
|
+
--oidc-issuer=<value>
|
|
1863
|
+
(required with oidc.*) Discovery base.
|
|
1864
|
+
|
|
1865
|
+
--oidc-jwks-uri=<value>
|
|
1866
|
+
JWKS endpoint, for a provider that exposes no .well-known document.
|
|
1867
|
+
|
|
1868
|
+
--[no-]oidc-pkce-enabled
|
|
1869
|
+
Send PKCE (code_challenge/code_verifier).
|
|
1870
|
+
|
|
1871
|
+
--oidc-scopes=<value>...
|
|
1872
|
+
Repeatable, one value each. Must contain `openid` - without it the provider
|
|
1873
|
+
returns no id_token and the connection is not OIDC.
|
|
1874
|
+
|
|
1875
|
+
--oidc-static-authorize-parameters=<value>...
|
|
1876
|
+
Repeatable oidc.static_authorize_parameters entry: key=value for a string,
|
|
1877
|
+
key:=value for JSON. Extra provider-specific authorize parameters (for
|
|
1878
|
+
example `prompt`).
|
|
1879
|
+
|
|
1880
|
+
--oidc-token-endpoint=<value>
|
|
1881
|
+
For a provider that exposes no .well-known document.
|
|
1882
|
+
|
|
1883
|
+
--oidc-token-endpoint-auth-method=<option>
|
|
1884
|
+
How the client authenticates at the token endpoint.
|
|
1885
|
+
<options: client_secret_basic|client_secret_post>
|
|
1886
|
+
|
|
1887
|
+
--oidc-userinfo-endpoint=<value>
|
|
1888
|
+
For a provider that exposes no .well-known document.
|
|
1889
|
+
|
|
1890
|
+
PROVISIONING FIELD FLAGS
|
|
1891
|
+
--provisioning-creation=<option> <options: disabled|auto>
|
|
1892
|
+
|
|
1893
|
+
DESCRIPTION
|
|
1894
|
+
Create an identity provider connection.
|
|
1895
|
+
|
|
1896
|
+
EXAMPLES
|
|
1897
|
+
$ zitadel idps create --slug acme-sso --protocol oidc --display-name 'Acme SSO' --oidc-issuer https://sso.acme.example --oidc-client-id <client_id> --oidc-client-secret '${{ ACME_SSO_CLIENT_SECRET }}' --oidc-scopes openid --oidc-scopes profile --oidc-scopes email --json
|
|
1898
|
+
|
|
1899
|
+
$ zitadel idps create --data '{...}' --json
|
|
1900
|
+
|
|
1901
|
+
$ zitadel idps create --file ./identity-provider-connection.json
|
|
1902
|
+
```
|
|
1903
|
+
|
|
1904
|
+
## `zitadel idps get ID`
|
|
1905
|
+
|
|
1906
|
+
Get one identity provider connection by id.
|
|
1907
|
+
|
|
1908
|
+
```
|
|
1909
|
+
USAGE
|
|
1910
|
+
$ zitadel idps get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
1911
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1912
|
+
<value>] [--fields <value>]
|
|
1913
|
+
|
|
1914
|
+
ARGUMENTS
|
|
1915
|
+
ID identity provider connection id
|
|
1916
|
+
|
|
1917
|
+
FLAGS
|
|
1918
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
1919
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
1920
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
1921
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
1922
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
1923
|
+
an agent.
|
|
1924
|
+
-s, --server=<value> Override the resolved server URL.
|
|
1925
|
+
-v, --verbose Verbose logging.
|
|
1926
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
1927
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
1928
|
+
--debug Debug logging.
|
|
1929
|
+
--dry-run Preview without mutating files or the platform.
|
|
1930
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
1931
|
+
process environment. Cannot be combined with --env.
|
|
1932
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
1933
|
+
the resource's own; `--json` is unaffected.
|
|
1934
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
1935
|
+
--no-telemetry.
|
|
1936
|
+
|
|
1937
|
+
GLOBAL FLAGS
|
|
1938
|
+
--json Format output as json.
|
|
1939
|
+
|
|
1940
|
+
DESCRIPTION
|
|
1941
|
+
Get one identity provider connection by id.
|
|
1942
|
+
|
|
1943
|
+
EXAMPLES
|
|
1944
|
+
$ zitadel idps get <id>
|
|
1945
|
+
|
|
1946
|
+
$ zitadel idps get <id> --json
|
|
1947
|
+
```
|
|
1948
|
+
|
|
1949
|
+
## `zitadel idps list`
|
|
1950
|
+
|
|
1951
|
+
List idps.
|
|
1952
|
+
|
|
1953
|
+
```
|
|
1954
|
+
USAGE
|
|
1955
|
+
$ zitadel idps list [--json] [-c <value>] [-s <value>] [-n]
|
|
1956
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
1957
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
1958
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
1959
|
+
|
|
1960
|
+
FLAGS
|
|
1961
|
+
-a, --all
|
|
1962
|
+
Fetch every page instead of one.
|
|
1963
|
+
|
|
1964
|
+
-c, --cwd=<value>
|
|
1965
|
+
Project directory to operate on.
|
|
1966
|
+
|
|
1967
|
+
-e, --env=<value>
|
|
1968
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
1969
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
1970
|
+
development.
|
|
1971
|
+
|
|
1972
|
+
-n, --non-interactive
|
|
1973
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
1974
|
+
|
|
1975
|
+
-s, --server=<value>
|
|
1976
|
+
Override the resolved server URL.
|
|
1977
|
+
|
|
1978
|
+
-v, --verbose
|
|
1979
|
+
Verbose logging.
|
|
1980
|
+
|
|
1981
|
+
--[no-]color
|
|
1982
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
1983
|
+
honored too.
|
|
1984
|
+
|
|
1985
|
+
--debug
|
|
1986
|
+
Debug logging.
|
|
1987
|
+
|
|
1988
|
+
--dry-run
|
|
1989
|
+
Preview without mutating files or the platform.
|
|
1990
|
+
|
|
1991
|
+
--env-file=<value>
|
|
1992
|
+
Read ZITADEL_* values from this file ahead of the process environment.
|
|
1993
|
+
Cannot be combined with --env.
|
|
1994
|
+
|
|
1995
|
+
--fields=<value>
|
|
1996
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
1997
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
1998
|
+
|
|
1999
|
+
--filter=<value>...
|
|
2000
|
+
Filter as field=operation:value (operation defaults to equals). Fields: slug
|
|
2001
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
2002
|
+
r_than|greater_than_or_equal), created_at (equals|not_equals|contains|not_co
|
|
2003
|
+
ntains|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
|
|
2004
|
+
|
|
2005
|
+
--limit=<value>
|
|
2006
|
+
Page size (server default 20, max 100).
|
|
2007
|
+
|
|
2008
|
+
--page-token=<value>
|
|
2009
|
+
Continue from a previous page's next_page_token.
|
|
2010
|
+
|
|
2011
|
+
--plain
|
|
2012
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
2013
|
+
terminal.
|
|
2014
|
+
|
|
2015
|
+
--sort=<value>
|
|
2016
|
+
Sort as field:direction (asc|desc). Fields: slug, created_at.
|
|
2017
|
+
|
|
2018
|
+
--[no-]telemetry
|
|
2019
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
2020
|
+
|
|
2021
|
+
GLOBAL FLAGS
|
|
2022
|
+
--json Format output as json.
|
|
2023
|
+
|
|
2024
|
+
DESCRIPTION
|
|
2025
|
+
List idps.
|
|
2026
|
+
|
|
2027
|
+
EXAMPLES
|
|
2028
|
+
$ zitadel idps list --json
|
|
2029
|
+
|
|
2030
|
+
$ zitadel idps list --all --json
|
|
2031
|
+
|
|
2032
|
+
$ zitadel idps list --filter slug=equals:<value> --sort slug:desc
|
|
2033
|
+
```
|
|
2034
|
+
|
|
2035
|
+
## `zitadel logs`
|
|
2036
|
+
|
|
2037
|
+
Show local Zitadel server logs.
|
|
2038
|
+
|
|
2039
|
+
```
|
|
2040
|
+
USAGE
|
|
2041
|
+
$ zitadel logs [--json] [-c <value>] [-s <value>] [-n]
|
|
2042
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--follow] [--level
|
|
2043
|
+
debug|info|warn|error] [--tail <value>]
|
|
2044
|
+
|
|
2045
|
+
FLAGS
|
|
2046
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2047
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2048
|
+
an agent.
|
|
2049
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2050
|
+
-v, --verbose Verbose logging.
|
|
2051
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2052
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2053
|
+
--debug Debug logging.
|
|
2054
|
+
--dry-run Preview without mutating files or the platform.
|
|
2055
|
+
--follow Keep printing lines as the server writes them.
|
|
2056
|
+
--level=<option> Show only lines at this level or above.
|
|
2057
|
+
<options: debug|info|warn|error>
|
|
2058
|
+
--tail=<value> [default: 200] Number of lines to show, counting only
|
|
2059
|
+
those --level shows.
|
|
2060
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2061
|
+
--no-telemetry.
|
|
2062
|
+
|
|
2063
|
+
GLOBAL FLAGS
|
|
2064
|
+
--json Format output as json.
|
|
2065
|
+
|
|
2066
|
+
DESCRIPTION
|
|
2067
|
+
Show local Zitadel server logs.
|
|
2068
|
+
|
|
2069
|
+
On a terminal, warnings are yellow and errors red. Run it in the directory
|
|
2070
|
+
`zitadel start` ran in, or one inside it: the server is found from the nearest
|
|
2071
|
+
`.zitadel/local/` on the way up.
|
|
2072
|
+
|
|
2073
|
+
EXAMPLES
|
|
2074
|
+
$ zitadel logs --follow
|
|
2075
|
+
|
|
2076
|
+
$ zitadel logs --level warn
|
|
2077
|
+
```
|
|
2078
|
+
|
|
2079
|
+
## `zitadel origin add PATTERN`
|
|
2080
|
+
|
|
2081
|
+
Add an origin pattern to the project.
|
|
2082
|
+
|
|
2083
|
+
```
|
|
2084
|
+
USAGE
|
|
2085
|
+
$ zitadel origin add PATTERN --kind primary|preview [--json] [-c
|
|
2086
|
+
<value>] [-s <value>] [-n] [--dry-run] [-v] [--debug] [--color]
|
|
2087
|
+
[--telemetry] [-e <value>] [--env-file <value>]
|
|
2088
|
+
|
|
2089
|
+
ARGUMENTS
|
|
2090
|
+
PATTERN The origin pattern to add.
|
|
2091
|
+
|
|
2092
|
+
FLAGS
|
|
2093
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2094
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2095
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2096
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2097
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2098
|
+
an agent.
|
|
2099
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2100
|
+
-v, --verbose Verbose logging.
|
|
2101
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2102
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2103
|
+
--debug Debug logging.
|
|
2104
|
+
--dry-run Preview without mutating files or the platform.
|
|
2105
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2106
|
+
process environment. Cannot be combined with --env.
|
|
2107
|
+
--kind=<option> (required) What the pattern is for.
|
|
2108
|
+
<options: primary|preview>
|
|
2109
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2110
|
+
--no-telemetry.
|
|
2111
|
+
|
|
2112
|
+
GLOBAL FLAGS
|
|
2113
|
+
--json Format output as json.
|
|
2114
|
+
|
|
2115
|
+
DESCRIPTION
|
|
2116
|
+
Add an origin pattern to the project.
|
|
2117
|
+
|
|
2118
|
+
EXAMPLES
|
|
2119
|
+
$ zitadel origin add https://app.acme.com --kind primary
|
|
2120
|
+
|
|
2121
|
+
$ zitadel origin add 'https://*-acme.vercel.app' --kind preview
|
|
2122
|
+
```
|
|
2123
|
+
|
|
2124
|
+
## `zitadel origin list`
|
|
2125
|
+
|
|
2126
|
+
List the origin patterns on the project.
|
|
2127
|
+
|
|
2128
|
+
```
|
|
2129
|
+
USAGE
|
|
2130
|
+
$ zitadel origin list [--json] [-c <value>] [-s <value>] [-n]
|
|
2131
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2132
|
+
<value>] [--plain]
|
|
2133
|
+
|
|
2134
|
+
FLAGS
|
|
2135
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2136
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2137
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2138
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2139
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2140
|
+
an agent.
|
|
2141
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2142
|
+
-v, --verbose Verbose logging.
|
|
2143
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2144
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2145
|
+
--debug Debug logging.
|
|
2146
|
+
--dry-run Preview without mutating files or the platform.
|
|
2147
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2148
|
+
process environment. Cannot be combined with --env.
|
|
2149
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
2150
|
+
when stdout is not a terminal.
|
|
2151
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2152
|
+
--no-telemetry.
|
|
2153
|
+
|
|
2154
|
+
GLOBAL FLAGS
|
|
2155
|
+
--json Format output as json.
|
|
2156
|
+
|
|
2157
|
+
DESCRIPTION
|
|
2158
|
+
List the origin patterns on the project.
|
|
2159
|
+
|
|
2160
|
+
EXAMPLES
|
|
2161
|
+
$ zitadel origin list
|
|
2162
|
+
|
|
2163
|
+
$ zitadel origin list --plain
|
|
2164
|
+
```
|
|
2165
|
+
|
|
2166
|
+
## `zitadel origin rm PATTERN`
|
|
2167
|
+
|
|
2168
|
+
Remove an origin pattern from the project.
|
|
2169
|
+
|
|
2170
|
+
```
|
|
2171
|
+
USAGE
|
|
2172
|
+
$ zitadel origin rm PATTERN [--json] [-c <value>] [-s <value>] [-n]
|
|
2173
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2174
|
+
<value>] [-f]
|
|
2175
|
+
|
|
2176
|
+
ARGUMENTS
|
|
2177
|
+
PATTERN The origin pattern to remove.
|
|
2178
|
+
|
|
2179
|
+
FLAGS
|
|
2180
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2181
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2182
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2183
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2184
|
+
-f, --force Remove the pattern without the confirmation prompt.
|
|
2185
|
+
Required when non-interactive.
|
|
2186
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2187
|
+
an agent.
|
|
2188
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2189
|
+
-v, --verbose Verbose logging.
|
|
2190
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2191
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2192
|
+
--debug Debug logging.
|
|
2193
|
+
--dry-run Preview without mutating files or the platform.
|
|
2194
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2195
|
+
process environment. Cannot be combined with --env.
|
|
2196
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2197
|
+
--no-telemetry.
|
|
2198
|
+
|
|
2199
|
+
GLOBAL FLAGS
|
|
2200
|
+
--json Format output as json.
|
|
2201
|
+
|
|
2202
|
+
DESCRIPTION
|
|
2203
|
+
Remove an origin pattern from the project.
|
|
2204
|
+
|
|
2205
|
+
EXAMPLES
|
|
2206
|
+
$ zitadel origin rm https://app.acme.com
|
|
2207
|
+
|
|
2208
|
+
$ zitadel origin rm https://app.acme.com --force
|
|
2209
|
+
```
|
|
2210
|
+
|
|
2211
|
+
## `zitadel policies get POLICY`
|
|
2212
|
+
|
|
2213
|
+
Get one policy by policy id or operation.
|
|
2214
|
+
|
|
2215
|
+
```
|
|
2216
|
+
USAGE
|
|
2217
|
+
$ zitadel policies get POLICY [--json] [-c <value>] [-s <value>] [-n]
|
|
2218
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2219
|
+
<value>] [--fields <value>]
|
|
2220
|
+
|
|
2221
|
+
ARGUMENTS
|
|
2222
|
+
POLICY policy id or operation
|
|
2223
|
+
|
|
2224
|
+
FLAGS
|
|
2225
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2226
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2227
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2228
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2229
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2230
|
+
an agent.
|
|
2231
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2232
|
+
-v, --verbose Verbose logging.
|
|
2233
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2234
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2235
|
+
--debug Debug logging.
|
|
2236
|
+
--dry-run Preview without mutating files or the platform.
|
|
2237
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2238
|
+
process environment. Cannot be combined with --env.
|
|
2239
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2240
|
+
the resource's own; `--json` is unaffected.
|
|
2241
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2242
|
+
--no-telemetry.
|
|
2243
|
+
|
|
2244
|
+
GLOBAL FLAGS
|
|
2245
|
+
--json Format output as json.
|
|
2246
|
+
|
|
2247
|
+
DESCRIPTION
|
|
2248
|
+
Get one policy by policy id or operation.
|
|
2249
|
+
|
|
2250
|
+
EXAMPLES
|
|
2251
|
+
$ zitadel policies get <policy>
|
|
2252
|
+
|
|
2253
|
+
$ zitadel policies get <policy> --json
|
|
2254
|
+
```
|
|
2255
|
+
|
|
2256
|
+
## `zitadel policies list`
|
|
2257
|
+
|
|
2258
|
+
List policies.
|
|
2259
|
+
|
|
2260
|
+
```
|
|
2261
|
+
USAGE
|
|
2262
|
+
$ zitadel policies list [--json] [-c <value>] [-s <value>] [-n]
|
|
2263
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2264
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2265
|
+
[--plain] [--filter <value>...]
|
|
2266
|
+
|
|
2267
|
+
FLAGS
|
|
2268
|
+
-a, --all Fetch every page instead of one.
|
|
2269
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2270
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2271
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2272
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2273
|
+
development.
|
|
2274
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2275
|
+
as an agent.
|
|
2276
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2277
|
+
-v, --verbose Verbose logging.
|
|
2278
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2279
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2280
|
+
--debug Debug logging.
|
|
2281
|
+
--dry-run Preview without mutating files or the platform.
|
|
2282
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2283
|
+
process environment. Cannot be combined with --env.
|
|
2284
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
2285
|
+
id,attributes.email). Defaults to the resource's own
|
|
2286
|
+
columns; `--json` is unaffected.
|
|
2287
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
2288
|
+
to equals). Fields: operation (equals).
|
|
2289
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
2290
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
2291
|
+
--plain Tab-separated rows with no header, for piping.
|
|
2292
|
+
Implied when stdout is not a terminal.
|
|
2293
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2294
|
+
--no-telemetry.
|
|
2295
|
+
|
|
2296
|
+
GLOBAL FLAGS
|
|
2297
|
+
--json Format output as json.
|
|
2298
|
+
|
|
2299
|
+
DESCRIPTION
|
|
2300
|
+
List policies.
|
|
2301
|
+
|
|
2302
|
+
EXAMPLES
|
|
2303
|
+
$ zitadel policies list --json
|
|
2304
|
+
|
|
2305
|
+
$ zitadel policies list --all --json
|
|
2306
|
+
|
|
2307
|
+
$ zitadel policies list --filter operation=equals:<value>
|
|
2308
|
+
```
|
|
2309
|
+
|
|
2310
|
+
## `zitadel preview`
|
|
2311
|
+
|
|
2312
|
+
Deploy a release from .zitadel/ to a pull-request build's preview URLs.
|
|
2313
|
+
|
|
2314
|
+
```
|
|
2315
|
+
USAGE
|
|
2316
|
+
$ zitadel preview [--json] [-c <value>] [-s <value>] [-n]
|
|
2317
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2318
|
+
<value>] [--origin <value>...] [--ttl <value>] [--strict]
|
|
2319
|
+
|
|
2320
|
+
FLAGS
|
|
2321
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2322
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2323
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2324
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2325
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2326
|
+
as an agent.
|
|
2327
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2328
|
+
-v, --verbose Verbose logging.
|
|
2329
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2330
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2331
|
+
--debug Debug logging.
|
|
2332
|
+
--dry-run Preview without mutating files or the platform.
|
|
2333
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2334
|
+
process environment. Cannot be combined with --env.
|
|
2335
|
+
--origin=<value>... A preview URL to deploy to, instead of detecting them
|
|
2336
|
+
from the platform build. Repeatable.
|
|
2337
|
+
--strict Fail instead of warning when no preview credential
|
|
2338
|
+
(ZITADEL_PROJECT_SECRET) is set.
|
|
2339
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2340
|
+
--no-telemetry.
|
|
2341
|
+
--ttl=<value> How long each preview stays live, e.g. 7d, 12h or
|
|
2342
|
+
90m. Between 60s and 365d. Omitted, the project's
|
|
2343
|
+
default applies.
|
|
2344
|
+
|
|
2345
|
+
GLOBAL FLAGS
|
|
2346
|
+
--json Format output as json.
|
|
2347
|
+
|
|
2348
|
+
DESCRIPTION
|
|
2349
|
+
Deploy a release from .zitadel/ to a pull-request build's preview URLs.
|
|
2350
|
+
|
|
2351
|
+
EXAMPLES
|
|
2352
|
+
$ zitadel preview
|
|
2353
|
+
|
|
2354
|
+
$ zitadel preview --origin https://acme-git-sso-acmeinc.vercel.app
|
|
2355
|
+
|
|
2356
|
+
$ zitadel preview --ttl 24h
|
|
2357
|
+
```
|
|
2358
|
+
|
|
2359
|
+
## `zitadel preview list`
|
|
2360
|
+
|
|
2361
|
+
List the project's live previews, newest first.
|
|
2362
|
+
|
|
2363
|
+
```
|
|
2364
|
+
USAGE
|
|
2365
|
+
$ zitadel preview list [--json] [-c <value>] [-s <value>] [-n]
|
|
2366
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2367
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--plain]
|
|
2368
|
+
|
|
2369
|
+
FLAGS
|
|
2370
|
+
-a, --all Fetch every page instead of one.
|
|
2371
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2372
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2373
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2374
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2375
|
+
development.
|
|
2376
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2377
|
+
as an agent.
|
|
2378
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2379
|
+
-v, --verbose Verbose logging.
|
|
2380
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2381
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2382
|
+
--debug Debug logging.
|
|
2383
|
+
--dry-run Preview without mutating files or the platform.
|
|
2384
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2385
|
+
process environment. Cannot be combined with --env.
|
|
2386
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
2387
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
2388
|
+
--plain Tab-separated rows with no header, for piping.
|
|
2389
|
+
Implied when stdout is not a terminal.
|
|
2390
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2391
|
+
--no-telemetry.
|
|
2392
|
+
|
|
2393
|
+
GLOBAL FLAGS
|
|
2394
|
+
--json Format output as json.
|
|
2395
|
+
|
|
2396
|
+
DESCRIPTION
|
|
2397
|
+
List the project's live previews, newest first.
|
|
2398
|
+
|
|
2399
|
+
EXAMPLES
|
|
2400
|
+
$ zitadel preview list
|
|
2401
|
+
|
|
2402
|
+
$ zitadel preview list --all
|
|
2403
|
+
|
|
2404
|
+
$ zitadel preview list --plain
|
|
2405
|
+
```
|
|
2406
|
+
|
|
2407
|
+
## `zitadel preview rm URL`
|
|
2408
|
+
|
|
2409
|
+
Remove a live preview from the project.
|
|
2410
|
+
|
|
2411
|
+
```
|
|
2412
|
+
USAGE
|
|
2413
|
+
$ zitadel preview rm URL [--json] [-c <value>] [-s <value>] [-n]
|
|
2414
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2415
|
+
<value>] [-f]
|
|
2416
|
+
|
|
2417
|
+
ARGUMENTS
|
|
2418
|
+
URL The preview URL to remove.
|
|
2419
|
+
|
|
2420
|
+
FLAGS
|
|
2421
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2422
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2423
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2424
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2425
|
+
-f, --force Remove the preview without the confirmation prompt.
|
|
2426
|
+
Required when non-interactive.
|
|
2427
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2428
|
+
an agent.
|
|
2429
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2430
|
+
-v, --verbose Verbose logging.
|
|
2431
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2432
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2433
|
+
--debug Debug logging.
|
|
2434
|
+
--dry-run Preview without mutating files or the platform.
|
|
2435
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2436
|
+
process environment. Cannot be combined with --env.
|
|
2437
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2438
|
+
--no-telemetry.
|
|
2439
|
+
|
|
2440
|
+
GLOBAL FLAGS
|
|
2441
|
+
--json Format output as json.
|
|
2442
|
+
|
|
2443
|
+
DESCRIPTION
|
|
2444
|
+
Remove a live preview from the project.
|
|
2445
|
+
|
|
2446
|
+
EXAMPLES
|
|
2447
|
+
$ zitadel preview rm https://acme-git-sso-acmeinc.vercel.app
|
|
2448
|
+
|
|
2449
|
+
$ zitadel preview rm https://acme-git-sso-acmeinc.vercel.app --force
|
|
2450
|
+
```
|
|
2451
|
+
|
|
2452
|
+
## `zitadel projects get ID`
|
|
2453
|
+
|
|
2454
|
+
Get one project by id.
|
|
2455
|
+
|
|
2456
|
+
```
|
|
2457
|
+
USAGE
|
|
2458
|
+
$ zitadel projects get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2459
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2460
|
+
<value>] [--fields <value>]
|
|
2461
|
+
|
|
2462
|
+
ARGUMENTS
|
|
2463
|
+
ID project id
|
|
2464
|
+
|
|
2465
|
+
FLAGS
|
|
2466
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2467
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2468
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2469
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2470
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2471
|
+
an agent.
|
|
2472
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2473
|
+
-v, --verbose Verbose logging.
|
|
2474
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2475
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2476
|
+
--debug Debug logging.
|
|
2477
|
+
--dry-run Preview without mutating files or the platform.
|
|
2478
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2479
|
+
process environment. Cannot be combined with --env.
|
|
2480
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2481
|
+
the resource's own; `--json` is unaffected.
|
|
2482
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2483
|
+
--no-telemetry.
|
|
2484
|
+
|
|
2485
|
+
GLOBAL FLAGS
|
|
2486
|
+
--json Format output as json.
|
|
2487
|
+
|
|
2488
|
+
DESCRIPTION
|
|
2489
|
+
Get one project by id.
|
|
2490
|
+
|
|
2491
|
+
EXAMPLES
|
|
2492
|
+
$ zitadel projects get <id>
|
|
2493
|
+
|
|
2494
|
+
$ zitadel projects get <id> --json
|
|
2495
|
+
```
|
|
2496
|
+
|
|
2497
|
+
## `zitadel projects list`
|
|
2498
|
+
|
|
2499
|
+
List projects.
|
|
2500
|
+
|
|
2501
|
+
```
|
|
2502
|
+
USAGE
|
|
2503
|
+
$ zitadel projects list [--json] [-c <value>] [-s <value>] [-n]
|
|
2504
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2505
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2506
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
2507
|
+
|
|
2508
|
+
FLAGS
|
|
2509
|
+
-a, --all Fetch every page instead of one.
|
|
2510
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2511
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2512
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2513
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2514
|
+
development.
|
|
2515
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2516
|
+
as an agent.
|
|
2517
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2518
|
+
-v, --verbose Verbose logging.
|
|
2519
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2520
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2521
|
+
--debug Debug logging.
|
|
2522
|
+
--dry-run Preview without mutating files or the platform.
|
|
2523
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2524
|
+
process environment. Cannot be combined with --env.
|
|
2525
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
2526
|
+
id,attributes.email). Defaults to the resource's own
|
|
2527
|
+
columns; `--json` is unaffected.
|
|
2528
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
2529
|
+
to equals). Fields: created_at (equals|not_equals|co
|
|
2530
|
+
ntains|not_contains|less_than|less_than_or_equal|gre
|
|
2531
|
+
ater_than|greater_than_or_equal).
|
|
2532
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
2533
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
2534
|
+
--plain Tab-separated rows with no header, for piping.
|
|
2535
|
+
Implied when stdout is not a terminal.
|
|
2536
|
+
--sort=<value> Sort as field:direction (asc|desc). Fields:
|
|
2537
|
+
created_at.
|
|
2538
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2539
|
+
--no-telemetry.
|
|
2540
|
+
|
|
2541
|
+
GLOBAL FLAGS
|
|
2542
|
+
--json Format output as json.
|
|
2543
|
+
|
|
2544
|
+
DESCRIPTION
|
|
2545
|
+
List projects.
|
|
2546
|
+
|
|
2547
|
+
EXAMPLES
|
|
2548
|
+
$ zitadel projects list --json
|
|
2549
|
+
|
|
2550
|
+
$ zitadel projects list --all --json
|
|
2551
|
+
|
|
2552
|
+
$ zitadel projects list --filter created_at=equals:<value> --sort created_at:desc
|
|
2553
|
+
```
|
|
2554
|
+
|
|
2555
|
+
## `zitadel projects update ID`
|
|
2556
|
+
|
|
2557
|
+
Update a project by id.
|
|
2558
|
+
|
|
2559
|
+
```
|
|
2560
|
+
USAGE
|
|
2561
|
+
$ zitadel projects update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2562
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2563
|
+
<value>] [--name <value>] [--password-hash-algorithm
|
|
2564
|
+
argon2i|argon2id|bcrypt|scrypt|pbkdf2|sha2] [--password-hash-params-time
|
|
2565
|
+
<value>] [--password-hash-params-memory <value>]
|
|
2566
|
+
[--password-hash-params-threads <value>] [--password-hash-params-cost
|
|
2567
|
+
<value>] [--password-hash-params-rounds <value>]
|
|
2568
|
+
[--password-hash-params-hash sha1|sha224|sha256|sha384|sha512] [--data
|
|
2569
|
+
<value> | --file <value>] [--set <value>...]
|
|
2570
|
+
|
|
2571
|
+
ARGUMENTS
|
|
2572
|
+
ID project id
|
|
2573
|
+
|
|
2574
|
+
FLAGS
|
|
2575
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2576
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2577
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2578
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2579
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2580
|
+
an agent.
|
|
2581
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2582
|
+
-v, --verbose Verbose logging.
|
|
2583
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2584
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2585
|
+
--debug Debug logging.
|
|
2586
|
+
--dry-run Preview without mutating files or the platform.
|
|
2587
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2588
|
+
process environment. Cannot be combined with --env.
|
|
2589
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2590
|
+
--no-telemetry.
|
|
2591
|
+
|
|
2592
|
+
RAW BODY FLAGS
|
|
2593
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
2594
|
+
over it.
|
|
2595
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
2596
|
+
and --set apply over it.
|
|
2597
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
2598
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
2599
|
+
key that contains a dot is set through its parent: --set
|
|
2600
|
+
'parent:={"a.b":"x"}'.
|
|
2601
|
+
|
|
2602
|
+
GLOBAL FLAGS
|
|
2603
|
+
--json Format output as json.
|
|
2604
|
+
|
|
2605
|
+
OPTIONAL FIELD FLAGS
|
|
2606
|
+
--name=<value> The name of the project.
|
|
2607
|
+
|
|
2608
|
+
PASSWORD HASH FIELD FLAGS
|
|
2609
|
+
--password-hash-algorithm=<option> (required with password_hash.*) The
|
|
2610
|
+
hashing algorithm.
|
|
2611
|
+
<options: argon2i|argon2id|bcrypt|scry
|
|
2612
|
+
pt|pbkdf2|sha2>
|
|
2613
|
+
--password-hash-params-cost=<value> bcrypt cost, or scrypt's log2 of the
|
|
2614
|
+
CPU/memory cost.
|
|
2615
|
+
--password-hash-params-hash=<option> The underlying hash.
|
|
2616
|
+
<options:
|
|
2617
|
+
sha1|sha224|sha256|sha384|sha512>
|
|
2618
|
+
--password-hash-params-memory=<value> argon2 memory in KiB.
|
|
2619
|
+
--password-hash-params-rounds=<value> pbkdf2 or sha2 iteration count.
|
|
2620
|
+
--password-hash-params-threads=<value> argon2 lanes.
|
|
2621
|
+
--password-hash-params-time=<value> argon2 passes over memory.
|
|
2622
|
+
|
|
2623
|
+
DESCRIPTION
|
|
2624
|
+
Update a project by id.
|
|
2625
|
+
|
|
2626
|
+
EXAMPLES
|
|
2627
|
+
$ zitadel projects update <id> --data '{...}' --json
|
|
2628
|
+
|
|
2629
|
+
$ zitadel projects update <id> --file ./project.json
|
|
2630
|
+
```
|
|
2631
|
+
|
|
2632
|
+
## `zitadel pull [TARGET]`
|
|
2633
|
+
|
|
2634
|
+
Rebuild your .zitadel/ files from a release.
|
|
2635
|
+
|
|
2636
|
+
```
|
|
2637
|
+
USAGE
|
|
2638
|
+
$ zitadel pull [TARGET] [--json] [-c <value>] [-s <value>] [-n]
|
|
2639
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2640
|
+
<value>]
|
|
2641
|
+
|
|
2642
|
+
ARGUMENTS
|
|
2643
|
+
[TARGET] [default: latest] What to pull: 'latest' (the live release), a
|
|
2644
|
+
release id (rel_…), or a deployment id (dep_…).
|
|
2645
|
+
|
|
2646
|
+
FLAGS
|
|
2647
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2648
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2649
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2650
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2651
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2652
|
+
an agent.
|
|
2653
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2654
|
+
-v, --verbose Verbose logging.
|
|
2655
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2656
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2657
|
+
--debug Debug logging.
|
|
2658
|
+
--dry-run Preview without mutating files or the platform.
|
|
2659
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2660
|
+
process environment. Cannot be combined with --env.
|
|
2661
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2662
|
+
--no-telemetry.
|
|
2663
|
+
|
|
2664
|
+
GLOBAL FLAGS
|
|
2665
|
+
--json Format output as json.
|
|
2666
|
+
|
|
2667
|
+
DESCRIPTION
|
|
2668
|
+
Rebuild your .zitadel/ files from a release.
|
|
2669
|
+
|
|
2670
|
+
Writes .zitadel/ from the revisions a released snapshot pins.
|
|
2671
|
+
|
|
2672
|
+
EXAMPLES
|
|
2673
|
+
$ zitadel pull
|
|
2674
|
+
|
|
2675
|
+
$ zitadel pull rel_01KX3RG8A7F0N9WD3P2E4YM5C1
|
|
2676
|
+
|
|
2677
|
+
$ zitadel pull dep_01KX5N7C9D2E7F0N9WD3P2E4YM6
|
|
2678
|
+
```
|
|
2679
|
+
|
|
2680
|
+
## `zitadel release create`
|
|
2681
|
+
|
|
2682
|
+
Build a release from .zitadel/ without deploying it.
|
|
2683
|
+
|
|
2684
|
+
```
|
|
2685
|
+
USAGE
|
|
2686
|
+
$ zitadel release create [--json] [-c <value>] [-s <value>] [-n]
|
|
2687
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2688
|
+
<value>] [-m <value>]
|
|
2689
|
+
|
|
2690
|
+
FLAGS
|
|
2691
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2692
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2693
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2694
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2695
|
+
-m, --message=<value> A short summary of what this release changes.
|
|
2696
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2697
|
+
an agent.
|
|
2698
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2699
|
+
-v, --verbose Verbose logging.
|
|
2700
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2701
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2702
|
+
--debug Debug logging.
|
|
2703
|
+
--dry-run Preview without mutating files or the platform.
|
|
2704
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2705
|
+
process environment. Cannot be combined with --env.
|
|
2706
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2707
|
+
--no-telemetry.
|
|
2708
|
+
|
|
2709
|
+
GLOBAL FLAGS
|
|
2710
|
+
--json Format output as json.
|
|
2711
|
+
|
|
2712
|
+
DESCRIPTION
|
|
2713
|
+
Build a release from .zitadel/ without deploying it.
|
|
2714
|
+
|
|
2715
|
+
EXAMPLES
|
|
2716
|
+
$ zitadel release create
|
|
2717
|
+
|
|
2718
|
+
$ zitadel release create -m 'add phone_number to human-user'
|
|
2719
|
+
```
|
|
2720
|
+
|
|
2721
|
+
## `zitadel release get ID`
|
|
2722
|
+
|
|
2723
|
+
Get one release by id.
|
|
2724
|
+
|
|
2725
|
+
```
|
|
2726
|
+
USAGE
|
|
2727
|
+
$ zitadel release get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
2728
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2729
|
+
<value>] [--fields <value>]
|
|
2730
|
+
|
|
2731
|
+
ARGUMENTS
|
|
2732
|
+
ID release id
|
|
2733
|
+
|
|
2734
|
+
FLAGS
|
|
2735
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2736
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2737
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2738
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2739
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2740
|
+
an agent.
|
|
2741
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2742
|
+
-v, --verbose Verbose logging.
|
|
2743
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2744
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2745
|
+
--debug Debug logging.
|
|
2746
|
+
--dry-run Preview without mutating files or the platform.
|
|
2747
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2748
|
+
process environment. Cannot be combined with --env.
|
|
2749
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2750
|
+
the resource's own; `--json` is unaffected.
|
|
2751
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2752
|
+
--no-telemetry.
|
|
2753
|
+
|
|
2754
|
+
GLOBAL FLAGS
|
|
2755
|
+
--json Format output as json.
|
|
2756
|
+
|
|
2757
|
+
DESCRIPTION
|
|
2758
|
+
Get one release by id.
|
|
2759
|
+
|
|
2760
|
+
EXAMPLES
|
|
2761
|
+
$ zitadel release get <id>
|
|
2762
|
+
|
|
2763
|
+
$ zitadel release get <id> --json
|
|
2764
|
+
```
|
|
2765
|
+
|
|
2766
|
+
## `zitadel release list`
|
|
2767
|
+
|
|
2768
|
+
List release.
|
|
2769
|
+
|
|
2770
|
+
```
|
|
2771
|
+
USAGE
|
|
2772
|
+
$ zitadel release list [--json] [-c <value>] [-s <value>] [-n]
|
|
2773
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2774
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2775
|
+
[--plain]
|
|
2776
|
+
|
|
2777
|
+
FLAGS
|
|
2778
|
+
-a, --all Fetch every page instead of one.
|
|
2779
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2780
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2781
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2782
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2783
|
+
development.
|
|
2784
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2785
|
+
as an agent.
|
|
2786
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2787
|
+
-v, --verbose Verbose logging.
|
|
2788
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2789
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2790
|
+
--debug Debug logging.
|
|
2791
|
+
--dry-run Preview without mutating files or the platform.
|
|
2792
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2793
|
+
process environment. Cannot be combined with --env.
|
|
2794
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
2795
|
+
id,attributes.email). Defaults to the resource's own
|
|
2796
|
+
columns; `--json` is unaffected.
|
|
2797
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
2798
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
2799
|
+
--plain Tab-separated rows with no header, for piping.
|
|
2800
|
+
Implied when stdout is not a terminal.
|
|
2801
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2802
|
+
--no-telemetry.
|
|
2803
|
+
|
|
2804
|
+
GLOBAL FLAGS
|
|
2805
|
+
--json Format output as json.
|
|
2806
|
+
|
|
2807
|
+
DESCRIPTION
|
|
2808
|
+
List release.
|
|
2809
|
+
|
|
2810
|
+
EXAMPLES
|
|
2811
|
+
$ zitadel release list --json
|
|
2812
|
+
|
|
2813
|
+
$ zitadel release list --all --json
|
|
2814
|
+
```
|
|
2815
|
+
|
|
2816
|
+
## `zitadel release revoke RELEASE_ID`
|
|
2817
|
+
|
|
2818
|
+
Revoke a release so its content is never served again.
|
|
2819
|
+
|
|
2820
|
+
```
|
|
2821
|
+
USAGE
|
|
2822
|
+
$ zitadel release revoke RELEASE_ID [--json] [-c <value>] [-s <value>]
|
|
2823
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
|
|
2824
|
+
[--env-file <value>] [-f]
|
|
2825
|
+
|
|
2826
|
+
ARGUMENTS
|
|
2827
|
+
RELEASE_ID The release to revoke.
|
|
2828
|
+
|
|
2829
|
+
FLAGS
|
|
2830
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2831
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2832
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2833
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2834
|
+
-f, --force Revoke without the confirmation prompt. Required when
|
|
2835
|
+
non-interactive.
|
|
2836
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2837
|
+
an agent.
|
|
2838
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2839
|
+
-v, --verbose Verbose logging.
|
|
2840
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2841
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2842
|
+
--debug Debug logging.
|
|
2843
|
+
--dry-run Preview without mutating files or the platform.
|
|
2844
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2845
|
+
process environment. Cannot be combined with --env.
|
|
2846
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2847
|
+
--no-telemetry.
|
|
2848
|
+
|
|
2849
|
+
GLOBAL FLAGS
|
|
2850
|
+
--json Format output as json.
|
|
2851
|
+
|
|
2852
|
+
DESCRIPTION
|
|
2853
|
+
Revoke a release so its content is never served again.
|
|
2854
|
+
|
|
2855
|
+
EXAMPLES
|
|
2856
|
+
$ zitadel release revoke rel_01KX3RG8A7F0N9WD3P2E4YM5C1
|
|
2857
|
+
|
|
2858
|
+
$ zitadel release revoke rel_01KX3RG8A7F0N9WD3P2E4YM5C1 --force
|
|
2859
|
+
```
|
|
2860
|
+
|
|
2861
|
+
## `zitadel reset`
|
|
2862
|
+
|
|
2863
|
+
Delete the local Zitadel server runtime and data.
|
|
2864
|
+
|
|
2865
|
+
```
|
|
2866
|
+
USAGE
|
|
2867
|
+
$ zitadel reset [--json] [-c <value>] [-s <value>] [-n]
|
|
2868
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
2869
|
+
|
|
2870
|
+
FLAGS
|
|
2871
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2872
|
+
-f, --force Delete the local runtime and its data without the
|
|
2873
|
+
confirmation prompt.
|
|
2874
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2875
|
+
an agent.
|
|
2876
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2877
|
+
-v, --verbose Verbose logging.
|
|
2878
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2879
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2880
|
+
--debug Debug logging.
|
|
2881
|
+
--dry-run Preview without mutating files or the platform.
|
|
2882
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2883
|
+
--no-telemetry.
|
|
2884
|
+
|
|
2885
|
+
GLOBAL FLAGS
|
|
2886
|
+
--json Format output as json.
|
|
2887
|
+
|
|
2888
|
+
DESCRIPTION
|
|
2889
|
+
Delete the local Zitadel server runtime and data.
|
|
2890
|
+
```
|
|
2891
|
+
|
|
2892
|
+
## `zitadel resources`
|
|
2893
|
+
|
|
2894
|
+
List the resources this CLI manages.
|
|
2895
|
+
|
|
2896
|
+
```
|
|
2897
|
+
USAGE
|
|
2898
|
+
$ zitadel resources [--json] [-c <value>] [-s <value>] [-n]
|
|
2899
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--plain]
|
|
2900
|
+
|
|
2901
|
+
FLAGS
|
|
2902
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2903
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2904
|
+
an agent.
|
|
2905
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2906
|
+
-v, --verbose Verbose logging.
|
|
2907
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2908
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2909
|
+
--debug Debug logging.
|
|
2910
|
+
--dry-run Preview without mutating files or the platform.
|
|
2911
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
2912
|
+
when stdout is not a terminal.
|
|
2913
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2914
|
+
--no-telemetry.
|
|
2915
|
+
|
|
2916
|
+
GLOBAL FLAGS
|
|
2917
|
+
--json Format output as json.
|
|
2918
|
+
|
|
2919
|
+
DESCRIPTION
|
|
2920
|
+
List the resources this CLI manages.
|
|
2921
|
+
|
|
2922
|
+
Shows what can be done to each.
|
|
2923
|
+
|
|
2924
|
+
EXAMPLES
|
|
2925
|
+
$ zitadel resources
|
|
2926
|
+
|
|
2927
|
+
$ zitadel resources --json
|
|
2928
|
+
|
|
2929
|
+
$ zitadel resources --json | jq -r '.data.items[] | "\(.topic): \(.verbs | join(", "))"'
|
|
2930
|
+
```
|
|
2931
|
+
|
|
2932
|
+
## `zitadel schemas get SCHEMA`
|
|
2933
|
+
|
|
2934
|
+
Get one schema by object type (current revision) or revision id.
|
|
2935
|
+
|
|
2936
|
+
```
|
|
2937
|
+
USAGE
|
|
2938
|
+
$ zitadel schemas get SCHEMA [--json] [-c <value>] [-s <value>] [-n]
|
|
2939
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2940
|
+
<value>] [--fields <value>]
|
|
2941
|
+
|
|
2942
|
+
ARGUMENTS
|
|
2943
|
+
SCHEMA object type (current revision) or revision id
|
|
2944
|
+
|
|
2945
|
+
FLAGS
|
|
2946
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2947
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
2948
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
2949
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
2950
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
2951
|
+
an agent.
|
|
2952
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2953
|
+
-v, --verbose Verbose logging.
|
|
2954
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
2955
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
2956
|
+
--debug Debug logging.
|
|
2957
|
+
--dry-run Preview without mutating files or the platform.
|
|
2958
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
2959
|
+
process environment. Cannot be combined with --env.
|
|
2960
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
2961
|
+
the resource's own; `--json` is unaffected.
|
|
2962
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
2963
|
+
--no-telemetry.
|
|
2964
|
+
|
|
2965
|
+
GLOBAL FLAGS
|
|
2966
|
+
--json Format output as json.
|
|
2967
|
+
|
|
2968
|
+
DESCRIPTION
|
|
2969
|
+
Get one schema by object type (current revision) or revision id.
|
|
2970
|
+
|
|
2971
|
+
EXAMPLES
|
|
2972
|
+
$ zitadel schemas get <schema>
|
|
2973
|
+
|
|
2974
|
+
$ zitadel schemas get <schema> --json
|
|
2975
|
+
```
|
|
2976
|
+
|
|
2977
|
+
## `zitadel schemas list`
|
|
2978
|
+
|
|
2979
|
+
List schemas.
|
|
2980
|
+
|
|
2981
|
+
```
|
|
2982
|
+
USAGE
|
|
2983
|
+
$ zitadel schemas list [--json] [-c <value>] [-s <value>] [-n]
|
|
2984
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
2985
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
2986
|
+
[--plain] [--filter <value>...]
|
|
2987
|
+
|
|
2988
|
+
FLAGS
|
|
2989
|
+
-a, --all Fetch every page instead of one.
|
|
2990
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
2991
|
+
-e, --env=<value> Environment to run against, e.g. production.
|
|
2992
|
+
Defaults to ZITADEL_ENV, then the hosting platform's
|
|
2993
|
+
build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
2994
|
+
development.
|
|
2995
|
+
-n, --non-interactive Disable prompts. Required when scripting or running
|
|
2996
|
+
as an agent.
|
|
2997
|
+
-s, --server=<value> Override the resolved server URL.
|
|
2998
|
+
-v, --verbose Verbose logging.
|
|
2999
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3000
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3001
|
+
--debug Debug logging.
|
|
3002
|
+
--dry-run Preview without mutating files or the platform.
|
|
3003
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3004
|
+
process environment. Cannot be combined with --env.
|
|
3005
|
+
--fields=<value> Columns to show, comma-separated dot-paths (e.g.
|
|
3006
|
+
id,attributes.email). Defaults to the resource's own
|
|
3007
|
+
columns; `--json` is unaffected.
|
|
3008
|
+
--filter=<value>... Filter as field=operation:value (operation defaults
|
|
3009
|
+
to equals). Fields: object_type (equals), kind
|
|
3010
|
+
(equals), revisions (equals; values all|latest).
|
|
3011
|
+
--limit=<value> Page size (server default 20, max 100).
|
|
3012
|
+
--page-token=<value> Continue from a previous page's next_page_token.
|
|
3013
|
+
--plain Tab-separated rows with no header, for piping.
|
|
3014
|
+
Implied when stdout is not a terminal.
|
|
3015
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3016
|
+
--no-telemetry.
|
|
3017
|
+
|
|
3018
|
+
GLOBAL FLAGS
|
|
3019
|
+
--json Format output as json.
|
|
3020
|
+
|
|
3021
|
+
DESCRIPTION
|
|
3022
|
+
List schemas.
|
|
3023
|
+
|
|
3024
|
+
EXAMPLES
|
|
3025
|
+
$ zitadel schemas list --json
|
|
3026
|
+
|
|
3027
|
+
$ zitadel schemas list --all --json
|
|
3028
|
+
|
|
3029
|
+
$ zitadel schemas list --filter object_type=equals:<value>
|
|
3030
|
+
```
|
|
3031
|
+
|
|
3032
|
+
## `zitadel search`
|
|
3033
|
+
|
|
3034
|
+
Search for a command.
|
|
3035
|
+
|
|
3036
|
+
```
|
|
3037
|
+
USAGE
|
|
3038
|
+
$ zitadel search
|
|
3039
|
+
|
|
3040
|
+
DESCRIPTION
|
|
3041
|
+
Search for a command.
|
|
3042
|
+
|
|
3043
|
+
Once you select a command, hit enter and it will show the help for that
|
|
3044
|
+
command.
|
|
3045
|
+
```
|
|
3046
|
+
|
|
3047
|
+
_See code: [@oclif/plugin-search](https://github.com/oclif/plugin-search/blob/v1.2.50/src/commands/search.ts)_
|
|
3048
|
+
|
|
3049
|
+
## `zitadel sessions get ID`
|
|
3050
|
+
|
|
3051
|
+
Get one session by id.
|
|
3052
|
+
|
|
3053
|
+
```
|
|
3054
|
+
USAGE
|
|
3055
|
+
$ zitadel sessions get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3056
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3057
|
+
<value>] [--fields <value>]
|
|
3058
|
+
|
|
3059
|
+
ARGUMENTS
|
|
3060
|
+
ID session id
|
|
3061
|
+
|
|
3062
|
+
FLAGS
|
|
3063
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3064
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3065
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3066
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3067
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3068
|
+
an agent.
|
|
3069
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3070
|
+
-v, --verbose Verbose logging.
|
|
3071
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3072
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3073
|
+
--debug Debug logging.
|
|
3074
|
+
--dry-run Preview without mutating files or the platform.
|
|
3075
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3076
|
+
process environment. Cannot be combined with --env.
|
|
3077
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3078
|
+
the resource's own; `--json` is unaffected.
|
|
3079
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3080
|
+
--no-telemetry.
|
|
3081
|
+
|
|
3082
|
+
GLOBAL FLAGS
|
|
3083
|
+
--json Format output as json.
|
|
3084
|
+
|
|
3085
|
+
DESCRIPTION
|
|
3086
|
+
Get one session by id.
|
|
3087
|
+
|
|
3088
|
+
EXAMPLES
|
|
3089
|
+
$ zitadel sessions get <id>
|
|
3090
|
+
|
|
3091
|
+
$ zitadel sessions get <id> --json
|
|
3092
|
+
```
|
|
3093
|
+
|
|
3094
|
+
## `zitadel sessions list`
|
|
3095
|
+
|
|
3096
|
+
List sessions.
|
|
3097
|
+
|
|
3098
|
+
```
|
|
3099
|
+
USAGE
|
|
3100
|
+
$ zitadel sessions list [--json] [-c <value>] [-s <value>] [-n]
|
|
3101
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3102
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
3103
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
3104
|
+
|
|
3105
|
+
FLAGS
|
|
3106
|
+
-a, --all
|
|
3107
|
+
Fetch every page instead of one.
|
|
3108
|
+
|
|
3109
|
+
-c, --cwd=<value>
|
|
3110
|
+
Project directory to operate on.
|
|
3111
|
+
|
|
3112
|
+
-e, --env=<value>
|
|
3113
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
3114
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
3115
|
+
development.
|
|
3116
|
+
|
|
3117
|
+
-n, --non-interactive
|
|
3118
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
3119
|
+
|
|
3120
|
+
-s, --server=<value>
|
|
3121
|
+
Override the resolved server URL.
|
|
3122
|
+
|
|
3123
|
+
-v, --verbose
|
|
3124
|
+
Verbose logging.
|
|
3125
|
+
|
|
3126
|
+
--[no-]color
|
|
3127
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
3128
|
+
honored too.
|
|
3129
|
+
|
|
3130
|
+
--debug
|
|
3131
|
+
Debug logging.
|
|
3132
|
+
|
|
3133
|
+
--dry-run
|
|
3134
|
+
Preview without mutating files or the platform.
|
|
3135
|
+
|
|
3136
|
+
--env-file=<value>
|
|
3137
|
+
Read ZITADEL_* values from this file ahead of the process environment.
|
|
3138
|
+
Cannot be combined with --env.
|
|
3139
|
+
|
|
3140
|
+
--fields=<value>
|
|
3141
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
3142
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
3143
|
+
|
|
3144
|
+
--filter=<value>...
|
|
3145
|
+
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
3146
|
+
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
3147
|
+
qual|greater_than|greater_than_or_equal), user_id
|
|
3148
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
3149
|
+
r_than|greater_than_or_equal), state (equals|not_equals|contains|not_contain
|
|
3150
|
+
s|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
3151
|
+
lifecycle_owner_team_id (equals|not_equals|contains|not_contains|less_than|l
|
|
3152
|
+
ess_than_or_equal|greater_than|greater_than_or_equal).
|
|
3153
|
+
|
|
3154
|
+
--limit=<value>
|
|
3155
|
+
Page size (server default 20, max 100).
|
|
3156
|
+
|
|
3157
|
+
--page-token=<value>
|
|
3158
|
+
Continue from a previous page's next_page_token.
|
|
3159
|
+
|
|
3160
|
+
--plain
|
|
3161
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
3162
|
+
terminal.
|
|
3163
|
+
|
|
3164
|
+
--sort=<value>
|
|
3165
|
+
Sort as field:direction (asc|desc). Fields: created_at, user_id.
|
|
3166
|
+
|
|
3167
|
+
--[no-]telemetry
|
|
3168
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
3169
|
+
|
|
3170
|
+
GLOBAL FLAGS
|
|
3171
|
+
--json Format output as json.
|
|
3172
|
+
|
|
3173
|
+
DESCRIPTION
|
|
3174
|
+
List sessions.
|
|
3175
|
+
|
|
3176
|
+
EXAMPLES
|
|
3177
|
+
$ zitadel sessions list --json
|
|
3178
|
+
|
|
3179
|
+
$ zitadel sessions list --all --json
|
|
3180
|
+
|
|
3181
|
+
$ zitadel sessions list --filter created_at=equals:<value> --sort created_at:desc
|
|
3182
|
+
```
|
|
3183
|
+
|
|
3184
|
+
## `zitadel sessions revoke ID`
|
|
3185
|
+
|
|
3186
|
+
Revoke a session by id.
|
|
3187
|
+
|
|
3188
|
+
```
|
|
3189
|
+
USAGE
|
|
3190
|
+
$ zitadel sessions revoke ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3191
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3192
|
+
<value>] [-f]
|
|
3193
|
+
|
|
3194
|
+
ARGUMENTS
|
|
3195
|
+
ID session id
|
|
3196
|
+
|
|
3197
|
+
FLAGS
|
|
3198
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3199
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3200
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3201
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3202
|
+
-f, --force Revoke the session without the confirmation prompt.
|
|
3203
|
+
Required when non-interactive.
|
|
3204
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3205
|
+
an agent.
|
|
3206
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3207
|
+
-v, --verbose Verbose logging.
|
|
3208
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3209
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3210
|
+
--debug Debug logging.
|
|
3211
|
+
--dry-run Preview without mutating files or the platform.
|
|
3212
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3213
|
+
process environment. Cannot be combined with --env.
|
|
3214
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3215
|
+
--no-telemetry.
|
|
3216
|
+
|
|
3217
|
+
GLOBAL FLAGS
|
|
3218
|
+
--json Format output as json.
|
|
3219
|
+
|
|
3220
|
+
DESCRIPTION
|
|
3221
|
+
Revoke a session by id.
|
|
3222
|
+
|
|
3223
|
+
EXAMPLES
|
|
3224
|
+
$ zitadel sessions revoke <id> --force --json
|
|
3225
|
+
```
|
|
3226
|
+
|
|
3227
|
+
## `zitadel setup`
|
|
3228
|
+
|
|
3229
|
+
Create a Zitadel project and scaffold local auth. An interactive setup ends with a note about the Zitadel agent skills, shown once per machine; set NO_SKILLS_PROMPT=1 to hide it.
|
|
3230
|
+
|
|
3231
|
+
```
|
|
3232
|
+
USAGE
|
|
3233
|
+
$ zitadel setup [--json] [-c <value>] [-s <value>] [-n]
|
|
3234
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f] [--framework
|
|
3235
|
+
next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|svelte|qwik-r
|
|
3236
|
+
outer|qwik|angular] [--renderer react] [--dev-port <value>] [--skip-install]
|
|
3237
|
+
[--preset password-first|passkey-first] [--use-case
|
|
3238
|
+
minimal|consumer|business] [--password-min-length <value>] [--sso
|
|
3239
|
+
google|custom] [--sso-client-id <value>] [--sso-slug <value>]
|
|
3240
|
+
[--sso-display-name <value>] [--sso-issuer <value>] [--sso-scopes <value>]
|
|
3241
|
+
|
|
3242
|
+
FLAGS
|
|
3243
|
+
-c, --cwd=<value>
|
|
3244
|
+
Project directory to operate on.
|
|
3245
|
+
|
|
3246
|
+
-f, --force
|
|
3247
|
+
Overwrite managed files that already exist, and scaffold into a non-empty
|
|
3248
|
+
directory.
|
|
3249
|
+
|
|
3250
|
+
-n, --non-interactive
|
|
3251
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
3252
|
+
|
|
3253
|
+
-s, --server=<value>
|
|
3254
|
+
Override the resolved server URL.
|
|
3255
|
+
|
|
3256
|
+
-v, --verbose
|
|
3257
|
+
Verbose logging.
|
|
3258
|
+
|
|
3259
|
+
--[no-]color
|
|
3260
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
3261
|
+
honored too.
|
|
3262
|
+
|
|
3263
|
+
--debug
|
|
3264
|
+
Debug logging.
|
|
3265
|
+
|
|
3266
|
+
--dev-port=<value>
|
|
3267
|
+
Dev-server port; also the issuer origin registered with Zitadel. Defaults to
|
|
3268
|
+
the detected port. Use distinct ports to run several scaffolded apps side by
|
|
3269
|
+
side. In an app already set up, moves it to this port: the dev script,
|
|
3270
|
+
ZITADEL_ISSUER and the allowed origin.
|
|
3271
|
+
|
|
3272
|
+
--dry-run
|
|
3273
|
+
Preview without mutating files or the platform.
|
|
3274
|
+
|
|
3275
|
+
--framework=<option>
|
|
3276
|
+
Framework to target.
|
|
3277
|
+
<options: next|nuxt|tanstack-start|react|vue|solid-start|solid|sveltekit|sve
|
|
3278
|
+
lte|qwik-router|qwik|angular>
|
|
3279
|
+
|
|
3280
|
+
--password-min-length=<value>
|
|
3281
|
+
Minimum password length for the project's password policy, for example 12; 0
|
|
3282
|
+
sets none. Without it, setup sets 15, the NIST minimum for password-only
|
|
3283
|
+
sign-in; change it in .zitadel/policies/ later.
|
|
3284
|
+
|
|
3285
|
+
--preset=<option>
|
|
3286
|
+
Sign-in preset for the scaffolded schema and login flow (default:
|
|
3287
|
+
password-first).
|
|
3288
|
+
<options: password-first|passkey-first>
|
|
3289
|
+
|
|
3290
|
+
--renderer=<option>
|
|
3291
|
+
Renderer (default: react). Not yet available: web-component.
|
|
3292
|
+
<options: react>
|
|
3293
|
+
|
|
3294
|
+
--skip-install
|
|
3295
|
+
Do not install dependencies after setup updates package.json.
|
|
3296
|
+
|
|
3297
|
+
--sso=<option>
|
|
3298
|
+
Social sign-in provider to enable while scaffolding, e.g. google. Skips the
|
|
3299
|
+
wizard's provider question; needs --sso-client-id, and the OAuth application
|
|
3300
|
+
must already be registered with the provider. Pipe the client secret in on
|
|
3301
|
+
stdin; never pass it as a flag.
|
|
3302
|
+
<options: google|custom>
|
|
3303
|
+
|
|
3304
|
+
--sso-client-id=<value>
|
|
3305
|
+
Client id of the OAuth application registered with the --sso provider.
|
|
3306
|
+
|
|
3307
|
+
--sso-display-name=<value>
|
|
3308
|
+
With --sso custom: the name shown on the sign-in button.
|
|
3309
|
+
|
|
3310
|
+
--sso-issuer=<value>
|
|
3311
|
+
With --sso custom: the provider's issuer URL. Its endpoints come from OIDC
|
|
3312
|
+
discovery.
|
|
3313
|
+
|
|
3314
|
+
--sso-scopes=<value>
|
|
3315
|
+
With --sso custom: the scopes to request, separated by spaces or commas.
|
|
3316
|
+
Must include openid. Default: openid profile email.
|
|
3317
|
+
|
|
3318
|
+
--sso-slug=<value>
|
|
3319
|
+
With --sso custom: the name of the connection. Schemas and flows refer to
|
|
3320
|
+
it.
|
|
3321
|
+
|
|
3322
|
+
--[no-]telemetry
|
|
3323
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
3324
|
+
|
|
3325
|
+
--use-case=<option>
|
|
3326
|
+
Use case for the scaffolded schema fields: who signs in to the app (default:
|
|
3327
|
+
minimal).
|
|
3328
|
+
<options: minimal|consumer|business>
|
|
3329
|
+
|
|
3330
|
+
GLOBAL FLAGS
|
|
3331
|
+
--json Format output as json.
|
|
3332
|
+
|
|
3333
|
+
DESCRIPTION
|
|
3334
|
+
Create a Zitadel project and scaffold local auth. An interactive setup ends
|
|
3335
|
+
with a note about the Zitadel agent skills, shown once per machine; set
|
|
3336
|
+
NO_SKILLS_PROMPT=1 to hide it.
|
|
3337
|
+
|
|
3338
|
+
EXAMPLES
|
|
3339
|
+
$ zitadel setup --framework next
|
|
3340
|
+
|
|
3341
|
+
$ zitadel setup --framework react --dev-port 3000
|
|
3342
|
+
```
|
|
3343
|
+
|
|
3344
|
+
## `zitadel start`
|
|
3345
|
+
|
|
3346
|
+
Start a local Zitadel server.
|
|
3347
|
+
|
|
3348
|
+
```
|
|
3349
|
+
USAGE
|
|
3350
|
+
$ zitadel start [--json] [-c <value>] [-s <value>] [-n]
|
|
3351
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--image <value>] [--port
|
|
3352
|
+
<value>] [--runtime binary|docker]
|
|
3353
|
+
|
|
3354
|
+
FLAGS
|
|
3355
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3356
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3357
|
+
an agent.
|
|
3358
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3359
|
+
-v, --verbose Verbose logging.
|
|
3360
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3361
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3362
|
+
--debug Debug logging.
|
|
3363
|
+
--dry-run Preview without mutating files or the platform.
|
|
3364
|
+
--image=<value> Container image to run.
|
|
3365
|
+
--port=<value> Local HTTP port. By default this directory keeps the
|
|
3366
|
+
port it had, or takes the first free one from 8080.
|
|
3367
|
+
--runtime=<option> Local runtime backend.
|
|
3368
|
+
<options: binary|docker>
|
|
3369
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3370
|
+
--no-telemetry.
|
|
3371
|
+
|
|
3372
|
+
GLOBAL FLAGS
|
|
3373
|
+
--json Format output as json.
|
|
3374
|
+
|
|
3375
|
+
DESCRIPTION
|
|
3376
|
+
Start a local Zitadel server.
|
|
3377
|
+
```
|
|
3378
|
+
|
|
3379
|
+
## `zitadel status`
|
|
3380
|
+
|
|
3381
|
+
Summarize the local Zitadel server and project state.
|
|
3382
|
+
|
|
3383
|
+
```
|
|
3384
|
+
USAGE
|
|
3385
|
+
$ zitadel status [--json] [-c <value>] [-s <value>] [-n]
|
|
3386
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3387
|
+
<value>]
|
|
3388
|
+
|
|
3389
|
+
FLAGS
|
|
3390
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3391
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3392
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3393
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3394
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3395
|
+
an agent.
|
|
3396
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3397
|
+
-v, --verbose Verbose logging.
|
|
3398
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3399
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3400
|
+
--debug Debug logging.
|
|
3401
|
+
--dry-run Preview without mutating files or the platform.
|
|
3402
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3403
|
+
process environment. Cannot be combined with --env.
|
|
3404
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3405
|
+
--no-telemetry.
|
|
3406
|
+
|
|
3407
|
+
GLOBAL FLAGS
|
|
3408
|
+
--json Format output as json.
|
|
3409
|
+
|
|
3410
|
+
DESCRIPTION
|
|
3411
|
+
Summarize the local Zitadel server and project state.
|
|
3412
|
+
```
|
|
3413
|
+
|
|
3414
|
+
## `zitadel stop`
|
|
3415
|
+
|
|
3416
|
+
Stop the local Zitadel server.
|
|
3417
|
+
|
|
3418
|
+
```
|
|
3419
|
+
USAGE
|
|
3420
|
+
$ zitadel stop [--json] [-c <value>] [-s <value>] [-n]
|
|
3421
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [--all]
|
|
3422
|
+
|
|
3423
|
+
FLAGS
|
|
3424
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3425
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3426
|
+
an agent.
|
|
3427
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3428
|
+
-v, --verbose Verbose logging.
|
|
3429
|
+
--all Stop all discovered CLI-managed local Zitadel runtime
|
|
3430
|
+
processes.
|
|
3431
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3432
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3433
|
+
--debug Debug logging.
|
|
3434
|
+
--dry-run Preview without mutating files or the platform.
|
|
3435
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3436
|
+
--no-telemetry.
|
|
3437
|
+
|
|
3438
|
+
GLOBAL FLAGS
|
|
3439
|
+
--json Format output as json.
|
|
3440
|
+
|
|
3441
|
+
DESCRIPTION
|
|
3442
|
+
Stop the local Zitadel server.
|
|
3443
|
+
```
|
|
3444
|
+
|
|
3445
|
+
## `zitadel teams create`
|
|
3446
|
+
|
|
3447
|
+
Create a team.
|
|
3448
|
+
|
|
3449
|
+
```
|
|
3450
|
+
USAGE
|
|
3451
|
+
$ zitadel teams create [--json] [-c <value>] [-s <value>] [-n]
|
|
3452
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3453
|
+
<value>] [--name <value>] [--data <value> | --file <value>] [--set
|
|
3454
|
+
<value>...]
|
|
3455
|
+
|
|
3456
|
+
FLAGS
|
|
3457
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3458
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3459
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3460
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3461
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3462
|
+
an agent.
|
|
3463
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3464
|
+
-v, --verbose Verbose logging.
|
|
3465
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3466
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3467
|
+
--debug Debug logging.
|
|
3468
|
+
--dry-run Preview without mutating files or the platform.
|
|
3469
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3470
|
+
process environment. Cannot be combined with --env.
|
|
3471
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3472
|
+
--no-telemetry.
|
|
3473
|
+
|
|
3474
|
+
RAW BODY FLAGS
|
|
3475
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
3476
|
+
over it.
|
|
3477
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
3478
|
+
and --set apply over it.
|
|
3479
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
3480
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
3481
|
+
key that contains a dot is set through its parent: --set
|
|
3482
|
+
'parent:={"a.b":"x"}'.
|
|
3483
|
+
|
|
3484
|
+
GLOBAL FLAGS
|
|
3485
|
+
--json Format output as json.
|
|
3486
|
+
|
|
3487
|
+
REQUIRED FIELD FLAGS
|
|
3488
|
+
--name=<value> (required) The name of the team.
|
|
3489
|
+
|
|
3490
|
+
DESCRIPTION
|
|
3491
|
+
Create a team.
|
|
3492
|
+
|
|
3493
|
+
EXAMPLES
|
|
3494
|
+
$ zitadel teams create --name <name> --json
|
|
3495
|
+
|
|
3496
|
+
$ zitadel teams create --data '{...}' --json
|
|
3497
|
+
|
|
3498
|
+
$ zitadel teams create --file ./team.json
|
|
3499
|
+
```
|
|
3500
|
+
|
|
3501
|
+
## `zitadel teams deactivate ID`
|
|
3502
|
+
|
|
3503
|
+
Deactivate a team by id.
|
|
3504
|
+
|
|
3505
|
+
```
|
|
3506
|
+
USAGE
|
|
3507
|
+
$ zitadel teams deactivate ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3508
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3509
|
+
<value>] [-f]
|
|
3510
|
+
|
|
3511
|
+
ARGUMENTS
|
|
3512
|
+
ID team id
|
|
3513
|
+
|
|
3514
|
+
FLAGS
|
|
3515
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3516
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3517
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3518
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3519
|
+
-f, --force Deactivate the team without the confirmation prompt.
|
|
3520
|
+
Required when non-interactive.
|
|
3521
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3522
|
+
an agent.
|
|
3523
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3524
|
+
-v, --verbose Verbose logging.
|
|
3525
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3526
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3527
|
+
--debug Debug logging.
|
|
3528
|
+
--dry-run Preview without mutating files or the platform.
|
|
3529
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3530
|
+
process environment. Cannot be combined with --env.
|
|
3531
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3532
|
+
--no-telemetry.
|
|
3533
|
+
|
|
3534
|
+
GLOBAL FLAGS
|
|
3535
|
+
--json Format output as json.
|
|
3536
|
+
|
|
3537
|
+
DESCRIPTION
|
|
3538
|
+
Deactivate a team by id.
|
|
3539
|
+
|
|
3540
|
+
EXAMPLES
|
|
3541
|
+
$ zitadel teams deactivate <id> --force --json
|
|
3542
|
+
```
|
|
3543
|
+
|
|
3544
|
+
## `zitadel teams get ID`
|
|
3545
|
+
|
|
3546
|
+
Get one team by id.
|
|
3547
|
+
|
|
3548
|
+
```
|
|
3549
|
+
USAGE
|
|
3550
|
+
$ zitadel teams get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3551
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3552
|
+
<value>] [--fields <value>]
|
|
3553
|
+
|
|
3554
|
+
ARGUMENTS
|
|
3555
|
+
ID team id
|
|
3556
|
+
|
|
3557
|
+
FLAGS
|
|
3558
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3559
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3560
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3561
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3562
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3563
|
+
an agent.
|
|
3564
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3565
|
+
-v, --verbose Verbose logging.
|
|
3566
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3567
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3568
|
+
--debug Debug logging.
|
|
3569
|
+
--dry-run Preview without mutating files or the platform.
|
|
3570
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3571
|
+
process environment. Cannot be combined with --env.
|
|
3572
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3573
|
+
the resource's own; `--json` is unaffected.
|
|
3574
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3575
|
+
--no-telemetry.
|
|
3576
|
+
|
|
3577
|
+
GLOBAL FLAGS
|
|
3578
|
+
--json Format output as json.
|
|
3579
|
+
|
|
3580
|
+
DESCRIPTION
|
|
3581
|
+
Get one team by id.
|
|
3582
|
+
|
|
3583
|
+
EXAMPLES
|
|
3584
|
+
$ zitadel teams get <id>
|
|
3585
|
+
|
|
3586
|
+
$ zitadel teams get <id> --json
|
|
3587
|
+
```
|
|
3588
|
+
|
|
3589
|
+
## `zitadel teams list`
|
|
3590
|
+
|
|
3591
|
+
List teams.
|
|
3592
|
+
|
|
3593
|
+
```
|
|
3594
|
+
USAGE
|
|
3595
|
+
$ zitadel teams list [--json] [-c <value>] [-s <value>] [-n]
|
|
3596
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3597
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
3598
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
3599
|
+
|
|
3600
|
+
FLAGS
|
|
3601
|
+
-a, --all
|
|
3602
|
+
Fetch every page instead of one.
|
|
3603
|
+
|
|
3604
|
+
-c, --cwd=<value>
|
|
3605
|
+
Project directory to operate on.
|
|
3606
|
+
|
|
3607
|
+
-e, --env=<value>
|
|
3608
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
3609
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
3610
|
+
development.
|
|
3611
|
+
|
|
3612
|
+
-n, --non-interactive
|
|
3613
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
3614
|
+
|
|
3615
|
+
-s, --server=<value>
|
|
3616
|
+
Override the resolved server URL.
|
|
3617
|
+
|
|
3618
|
+
-v, --verbose
|
|
3619
|
+
Verbose logging.
|
|
3620
|
+
|
|
3621
|
+
--[no-]color
|
|
3622
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
3623
|
+
honored too.
|
|
3624
|
+
|
|
3625
|
+
--debug
|
|
3626
|
+
Debug logging.
|
|
3627
|
+
|
|
3628
|
+
--dry-run
|
|
3629
|
+
Preview without mutating files or the platform.
|
|
3630
|
+
|
|
3631
|
+
--env-file=<value>
|
|
3632
|
+
Read ZITADEL_* values from this file ahead of the process environment.
|
|
3633
|
+
Cannot be combined with --env.
|
|
3634
|
+
|
|
3635
|
+
--fields=<value>
|
|
3636
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
3637
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
3638
|
+
|
|
3639
|
+
--filter=<value>...
|
|
3640
|
+
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
3641
|
+
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
3642
|
+
qual|greater_than|greater_than_or_equal), name
|
|
3643
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
3644
|
+
r_than|greater_than_or_equal), status (equals|not_equals|contains|not_contai
|
|
3645
|
+
ns|less_than|less_than_or_equal|greater_than|greater_than_or_equal).
|
|
3646
|
+
|
|
3647
|
+
--limit=<value>
|
|
3648
|
+
Page size (server default 20, max 100).
|
|
3649
|
+
|
|
3650
|
+
--page-token=<value>
|
|
3651
|
+
Continue from a previous page's next_page_token.
|
|
3652
|
+
|
|
3653
|
+
--plain
|
|
3654
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
3655
|
+
terminal.
|
|
3656
|
+
|
|
3657
|
+
--sort=<value>
|
|
3658
|
+
Sort as field:direction (asc|desc). Fields: created_at, name, status.
|
|
3659
|
+
|
|
3660
|
+
--[no-]telemetry
|
|
3661
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
3662
|
+
|
|
3663
|
+
GLOBAL FLAGS
|
|
3664
|
+
--json Format output as json.
|
|
3665
|
+
|
|
3666
|
+
DESCRIPTION
|
|
3667
|
+
List teams.
|
|
3668
|
+
|
|
3669
|
+
EXAMPLES
|
|
3670
|
+
$ zitadel teams list --json
|
|
3671
|
+
|
|
3672
|
+
$ zitadel teams list --all --json
|
|
3673
|
+
|
|
3674
|
+
$ zitadel teams list --filter created_at=equals:<value> --sort created_at:desc
|
|
3675
|
+
```
|
|
3676
|
+
|
|
3677
|
+
## `zitadel teams update ID`
|
|
3678
|
+
|
|
3679
|
+
Update a team by id.
|
|
3680
|
+
|
|
3681
|
+
```
|
|
3682
|
+
USAGE
|
|
3683
|
+
$ zitadel teams update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3684
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3685
|
+
<value>] [--name <value>] [--data <value> | --file <value>] [--set
|
|
3686
|
+
<value>...]
|
|
3687
|
+
|
|
3688
|
+
ARGUMENTS
|
|
3689
|
+
ID team id
|
|
3690
|
+
|
|
3691
|
+
FLAGS
|
|
3692
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3693
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3694
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3695
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3696
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3697
|
+
an agent.
|
|
3698
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3699
|
+
-v, --verbose Verbose logging.
|
|
3700
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3701
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3702
|
+
--debug Debug logging.
|
|
3703
|
+
--dry-run Preview without mutating files or the platform.
|
|
3704
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3705
|
+
process environment. Cannot be combined with --env.
|
|
3706
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3707
|
+
--no-telemetry.
|
|
3708
|
+
|
|
3709
|
+
RAW BODY FLAGS
|
|
3710
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
3711
|
+
over it.
|
|
3712
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
3713
|
+
and --set apply over it.
|
|
3714
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
3715
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
3716
|
+
key that contains a dot is set through its parent: --set
|
|
3717
|
+
'parent:={"a.b":"x"}'.
|
|
3718
|
+
|
|
3719
|
+
GLOBAL FLAGS
|
|
3720
|
+
--json Format output as json.
|
|
3721
|
+
|
|
3722
|
+
OPTIONAL FIELD FLAGS
|
|
3723
|
+
--name=<value> The name of the team.
|
|
3724
|
+
|
|
3725
|
+
DESCRIPTION
|
|
3726
|
+
Update a team by id.
|
|
3727
|
+
|
|
3728
|
+
EXAMPLES
|
|
3729
|
+
$ zitadel teams update <id> --data '{...}' --json
|
|
3730
|
+
|
|
3731
|
+
$ zitadel teams update <id> --file ./team.json
|
|
3732
|
+
```
|
|
3733
|
+
|
|
3734
|
+
## `zitadel uninstall`
|
|
3735
|
+
|
|
3736
|
+
Remove managed files and local Zitadel state.
|
|
3737
|
+
|
|
3738
|
+
```
|
|
3739
|
+
USAGE
|
|
3740
|
+
$ zitadel uninstall [--json] [-c <value>] [-s <value>] [-n]
|
|
3741
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-f]
|
|
3742
|
+
|
|
3743
|
+
FLAGS
|
|
3744
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3745
|
+
-f, --force Remove the managed files without the confirmation
|
|
3746
|
+
prompt.
|
|
3747
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3748
|
+
an agent.
|
|
3749
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3750
|
+
-v, --verbose Verbose logging.
|
|
3751
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3752
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3753
|
+
--debug Debug logging.
|
|
3754
|
+
--dry-run Preview without mutating files or the platform.
|
|
3755
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3756
|
+
--no-telemetry.
|
|
3757
|
+
|
|
3758
|
+
GLOBAL FLAGS
|
|
3759
|
+
--json Format output as json.
|
|
3760
|
+
|
|
3761
|
+
DESCRIPTION
|
|
3762
|
+
Remove managed files and local Zitadel state.
|
|
3763
|
+
|
|
3764
|
+
ALIASES
|
|
3765
|
+
$ zitadel uninstall
|
|
3766
|
+
```
|
|
3767
|
+
|
|
3768
|
+
## `zitadel users create`
|
|
3769
|
+
|
|
3770
|
+
Create a user.
|
|
3771
|
+
|
|
3772
|
+
```
|
|
3773
|
+
USAGE
|
|
3774
|
+
$ zitadel users create [--json] [-c <value>] [-s <value>] [-n]
|
|
3775
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3776
|
+
<value>] [--schema <value>] [--attributes <value>...] [--data <value> |
|
|
3777
|
+
--file <value>] [--set <value>...]
|
|
3778
|
+
|
|
3779
|
+
FLAGS
|
|
3780
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3781
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3782
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3783
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3784
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3785
|
+
an agent.
|
|
3786
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3787
|
+
-v, --verbose Verbose logging.
|
|
3788
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3789
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3790
|
+
--debug Debug logging.
|
|
3791
|
+
--dry-run Preview without mutating files or the platform.
|
|
3792
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3793
|
+
process environment. Cannot be combined with --env.
|
|
3794
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3795
|
+
--no-telemetry.
|
|
3796
|
+
|
|
3797
|
+
REQUIRED FIELD FLAGS
|
|
3798
|
+
--attributes=<value>... (required) Repeatable attributes entry: key=value for
|
|
3799
|
+
a string, key:=value for JSON. The user's
|
|
3800
|
+
schema-defined content.
|
|
3801
|
+
--schema=<value> (required) The schema that defines the content of
|
|
3802
|
+
`attributes`.
|
|
3803
|
+
|
|
3804
|
+
RAW BODY FLAGS
|
|
3805
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
3806
|
+
over it.
|
|
3807
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
3808
|
+
and --set apply over it.
|
|
3809
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
3810
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
3811
|
+
key that contains a dot is set through its parent: --set
|
|
3812
|
+
'parent:={"a.b":"x"}'.
|
|
3813
|
+
|
|
3814
|
+
GLOBAL FLAGS
|
|
3815
|
+
--json Format output as json.
|
|
3816
|
+
|
|
3817
|
+
DESCRIPTION
|
|
3818
|
+
Create a user.
|
|
3819
|
+
|
|
3820
|
+
EXAMPLES
|
|
3821
|
+
$ zitadel users create --schema <schema> --attributes <key>=<value> --json
|
|
3822
|
+
|
|
3823
|
+
$ zitadel users create --data '{...}' --json
|
|
3824
|
+
|
|
3825
|
+
$ zitadel users create --file ./user.json
|
|
3826
|
+
```
|
|
3827
|
+
|
|
3828
|
+
## `zitadel users delete ID`
|
|
3829
|
+
|
|
3830
|
+
Delete a user by id.
|
|
3831
|
+
|
|
3832
|
+
```
|
|
3833
|
+
USAGE
|
|
3834
|
+
$ zitadel users delete ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3835
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3836
|
+
<value>] [-f]
|
|
3837
|
+
|
|
3838
|
+
ARGUMENTS
|
|
3839
|
+
ID user id
|
|
3840
|
+
|
|
3841
|
+
FLAGS
|
|
3842
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3843
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3844
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3845
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3846
|
+
-f, --force Delete the user without the confirmation prompt.
|
|
3847
|
+
Required when non-interactive.
|
|
3848
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3849
|
+
an agent.
|
|
3850
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3851
|
+
-v, --verbose Verbose logging.
|
|
3852
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3853
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3854
|
+
--debug Debug logging.
|
|
3855
|
+
--dry-run Preview without mutating files or the platform.
|
|
3856
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3857
|
+
process environment. Cannot be combined with --env.
|
|
3858
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3859
|
+
--no-telemetry.
|
|
3860
|
+
|
|
3861
|
+
GLOBAL FLAGS
|
|
3862
|
+
--json Format output as json.
|
|
3863
|
+
|
|
3864
|
+
DESCRIPTION
|
|
3865
|
+
Delete a user by id.
|
|
3866
|
+
|
|
3867
|
+
EXAMPLES
|
|
3868
|
+
$ zitadel users delete <id> --force --json
|
|
3869
|
+
```
|
|
3870
|
+
|
|
3871
|
+
## `zitadel users get ID`
|
|
3872
|
+
|
|
3873
|
+
Get one user by id.
|
|
3874
|
+
|
|
3875
|
+
```
|
|
3876
|
+
USAGE
|
|
3877
|
+
$ zitadel users get ID [--json] [-c <value>] [-s <value>] [-n]
|
|
3878
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3879
|
+
<value>] [--fields <value>]
|
|
3880
|
+
|
|
3881
|
+
ARGUMENTS
|
|
3882
|
+
ID user id
|
|
3883
|
+
|
|
3884
|
+
FLAGS
|
|
3885
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
3886
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
3887
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
3888
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
3889
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
3890
|
+
an agent.
|
|
3891
|
+
-s, --server=<value> Override the resolved server URL.
|
|
3892
|
+
-v, --verbose Verbose logging.
|
|
3893
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
3894
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
3895
|
+
--debug Debug logging.
|
|
3896
|
+
--dry-run Preview without mutating files or the platform.
|
|
3897
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
3898
|
+
process environment. Cannot be combined with --env.
|
|
3899
|
+
--fields=<value> Fields to show, comma-separated dot-paths. Defaults to
|
|
3900
|
+
the resource's own; `--json` is unaffected.
|
|
3901
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
3902
|
+
--no-telemetry.
|
|
3903
|
+
|
|
3904
|
+
GLOBAL FLAGS
|
|
3905
|
+
--json Format output as json.
|
|
3906
|
+
|
|
3907
|
+
DESCRIPTION
|
|
3908
|
+
Get one user by id.
|
|
3909
|
+
|
|
3910
|
+
EXAMPLES
|
|
3911
|
+
$ zitadel users get <id>
|
|
3912
|
+
|
|
3913
|
+
$ zitadel users get <id> --json
|
|
3914
|
+
```
|
|
3915
|
+
|
|
3916
|
+
## `zitadel users list`
|
|
3917
|
+
|
|
3918
|
+
List users.
|
|
3919
|
+
|
|
3920
|
+
```
|
|
3921
|
+
USAGE
|
|
3922
|
+
$ zitadel users list [--json] [-c <value>] [-s <value>] [-n]
|
|
3923
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
3924
|
+
<value>] [--limit <value>] [-a | --page-token <value>] [--fields <value>]
|
|
3925
|
+
[--plain] [--filter <value>...] [--sort <value>]
|
|
3926
|
+
|
|
3927
|
+
FLAGS
|
|
3928
|
+
-a, --all
|
|
3929
|
+
Fetch every page instead of one.
|
|
3930
|
+
|
|
3931
|
+
-c, --cwd=<value>
|
|
3932
|
+
Project directory to operate on.
|
|
3933
|
+
|
|
3934
|
+
-e, --env=<value>
|
|
3935
|
+
Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then
|
|
3936
|
+
the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then
|
|
3937
|
+
development.
|
|
3938
|
+
|
|
3939
|
+
-n, --non-interactive
|
|
3940
|
+
Disable prompts. Required when scripting or running as an agent.
|
|
3941
|
+
|
|
3942
|
+
-s, --server=<value>
|
|
3943
|
+
Override the resolved server URL.
|
|
3944
|
+
|
|
3945
|
+
-v, --verbose
|
|
3946
|
+
Verbose logging.
|
|
3947
|
+
|
|
3948
|
+
--[no-]color
|
|
3949
|
+
Colorize human output. Disable with --no-color; NO_COLOR and FORCE_COLOR are
|
|
3950
|
+
honored too.
|
|
3951
|
+
|
|
3952
|
+
--debug
|
|
3953
|
+
Debug logging.
|
|
3954
|
+
|
|
3955
|
+
--dry-run
|
|
3956
|
+
Preview without mutating files or the platform.
|
|
3957
|
+
|
|
3958
|
+
--env-file=<value>
|
|
3959
|
+
Read ZITADEL_* values from this file ahead of the process environment.
|
|
3960
|
+
Cannot be combined with --env.
|
|
3961
|
+
|
|
3962
|
+
--fields=<value>
|
|
3963
|
+
Columns to show, comma-separated dot-paths (e.g. id,attributes.email).
|
|
3964
|
+
Defaults to the resource's own columns; `--json` is unaffected.
|
|
3965
|
+
|
|
3966
|
+
--filter=<value>...
|
|
3967
|
+
Filter as field=operation:value (operation defaults to equals). Fields:
|
|
3968
|
+
created_at (equals|not_equals|contains|not_contains|less_than|less_than_or_e
|
|
3969
|
+
qual|greater_than|greater_than_or_equal), id (equals|not_equals|contains|not
|
|
3970
|
+
_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
3971
|
+
schema (equals|not_equals|contains|not_contains|less_than|less_than_or_equal
|
|
3972
|
+
|greater_than|greater_than_or_equal), status (equals|not_equals|contains|not
|
|
3973
|
+
_contains|less_than|less_than_or_equal|greater_than|greater_than_or_equal),
|
|
3974
|
+
team_id (equals|not_equals|contains|not_contains|less_than|less_than_or_equa
|
|
3975
|
+
l|greater_than|greater_than_or_equal), lifecycle_owner_team_id
|
|
3976
|
+
(equals|not_equals|contains|not_contains|less_than|less_than_or_equal|greate
|
|
3977
|
+
r_than|greater_than_or_equal).
|
|
3978
|
+
|
|
3979
|
+
--limit=<value>
|
|
3980
|
+
Page size (server default 20, max 100).
|
|
3981
|
+
|
|
3982
|
+
--page-token=<value>
|
|
3983
|
+
Continue from a previous page's next_page_token.
|
|
3984
|
+
|
|
3985
|
+
--plain
|
|
3986
|
+
Tab-separated rows with no header, for piping. Implied when stdout is not a
|
|
3987
|
+
terminal.
|
|
3988
|
+
|
|
3989
|
+
--sort=<value>
|
|
3990
|
+
Sort as field:direction (asc|desc). Fields: created_at, id, schema, status,
|
|
3991
|
+
lifecycle_owner_team_id.
|
|
3992
|
+
|
|
3993
|
+
--[no-]telemetry
|
|
3994
|
+
Send anonymous usage analytics. Disable with --no-telemetry.
|
|
3995
|
+
|
|
3996
|
+
GLOBAL FLAGS
|
|
3997
|
+
--json Format output as json.
|
|
3998
|
+
|
|
3999
|
+
DESCRIPTION
|
|
4000
|
+
List users.
|
|
4001
|
+
|
|
4002
|
+
EXAMPLES
|
|
4003
|
+
$ zitadel users list --json
|
|
4004
|
+
|
|
4005
|
+
$ zitadel users list --all --json
|
|
4006
|
+
|
|
4007
|
+
$ zitadel users list --filter created_at=equals:<value> --sort created_at:desc
|
|
4008
|
+
```
|
|
4009
|
+
|
|
4010
|
+
## `zitadel users update ID`
|
|
4011
|
+
|
|
4012
|
+
Update a user by id.
|
|
4013
|
+
|
|
4014
|
+
```
|
|
4015
|
+
USAGE
|
|
4016
|
+
$ zitadel users update ID [--json] [-c <value>] [-s <value>] [-n]
|
|
4017
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4018
|
+
<value>] [--schema <value>] [--attributes <value>...] [--data <value> |
|
|
4019
|
+
--file <value>] [--set <value>...]
|
|
4020
|
+
|
|
4021
|
+
ARGUMENTS
|
|
4022
|
+
ID user id
|
|
4023
|
+
|
|
4024
|
+
FLAGS
|
|
4025
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4026
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4027
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4028
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4029
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4030
|
+
an agent.
|
|
4031
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4032
|
+
-v, --verbose Verbose logging.
|
|
4033
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4034
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4035
|
+
--debug Debug logging.
|
|
4036
|
+
--dry-run Preview without mutating files or the platform.
|
|
4037
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4038
|
+
process environment. Cannot be combined with --env.
|
|
4039
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4040
|
+
--no-telemetry.
|
|
4041
|
+
|
|
4042
|
+
OPTIONAL FIELD FLAGS
|
|
4043
|
+
--attributes=<value>... Repeatable attributes entry: key=value for a string,
|
|
4044
|
+
key:=value for JSON. The changed attributes only.
|
|
4045
|
+
--schema=<value> The schema the user follows after this patch.
|
|
4046
|
+
|
|
4047
|
+
RAW BODY FLAGS
|
|
4048
|
+
--data=<value> Whole body as a JSON object. Field flags and --set apply
|
|
4049
|
+
over it.
|
|
4050
|
+
--file=<value> Read the body from a JSON file; `-` reads stdin. Field flags
|
|
4051
|
+
and --set apply over it.
|
|
4052
|
+
--set=<value>... Set one field by its dot path: path=value, or path:=json for
|
|
4053
|
+
JSON. Repeatable; applied after the field flags, in order. A
|
|
4054
|
+
key that contains a dot is set through its parent: --set
|
|
4055
|
+
'parent:={"a.b":"x"}'.
|
|
4056
|
+
|
|
4057
|
+
GLOBAL FLAGS
|
|
4058
|
+
--json Format output as json.
|
|
4059
|
+
|
|
4060
|
+
DESCRIPTION
|
|
4061
|
+
Update a user by id.
|
|
4062
|
+
|
|
4063
|
+
EXAMPLES
|
|
4064
|
+
$ zitadel users update <id> --data '{...}' --json
|
|
4065
|
+
|
|
4066
|
+
$ zitadel users update <id> --file ./user.json
|
|
4067
|
+
```
|
|
4068
|
+
|
|
4069
|
+
## `zitadel variable get NAME`
|
|
4070
|
+
|
|
4071
|
+
Get one variable from the project.
|
|
4072
|
+
|
|
4073
|
+
```
|
|
4074
|
+
USAGE
|
|
4075
|
+
$ zitadel variable get NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
4076
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4077
|
+
<value>] [--preview]
|
|
4078
|
+
|
|
4079
|
+
ARGUMENTS
|
|
4080
|
+
NAME Variable name to read.
|
|
4081
|
+
|
|
4082
|
+
FLAGS
|
|
4083
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4084
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4085
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4086
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4087
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4088
|
+
an agent.
|
|
4089
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4090
|
+
-v, --verbose Verbose logging.
|
|
4091
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4092
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4093
|
+
--debug Debug logging.
|
|
4094
|
+
--dry-run Preview without mutating files or the platform.
|
|
4095
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4096
|
+
process environment. Cannot be combined with --env.
|
|
4097
|
+
--preview Read the preview value instead of the primary one.
|
|
4098
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4099
|
+
--no-telemetry.
|
|
4100
|
+
|
|
4101
|
+
GLOBAL FLAGS
|
|
4102
|
+
--json Format output as json.
|
|
4103
|
+
|
|
4104
|
+
DESCRIPTION
|
|
4105
|
+
Get one variable from the project.
|
|
4106
|
+
|
|
4107
|
+
EXAMPLES
|
|
4108
|
+
$ zitadel variable get GOOGLE_CLIENT_ID
|
|
4109
|
+
|
|
4110
|
+
$ zitadel variable get API_URL --preview
|
|
4111
|
+
|
|
4112
|
+
$ zitadel variable get GOOGLE_CLIENT_ID --json
|
|
4113
|
+
```
|
|
4114
|
+
|
|
4115
|
+
## `zitadel variable list`
|
|
4116
|
+
|
|
4117
|
+
List the variables entered on the project.
|
|
4118
|
+
|
|
4119
|
+
```
|
|
4120
|
+
USAGE
|
|
4121
|
+
$ zitadel variable list [--json] [-c <value>] [-s <value>] [-n]
|
|
4122
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4123
|
+
<value>] [--preview] [--plain]
|
|
4124
|
+
|
|
4125
|
+
FLAGS
|
|
4126
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4127
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4128
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4129
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4130
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4131
|
+
an agent.
|
|
4132
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4133
|
+
-v, --verbose Verbose logging.
|
|
4134
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4135
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4136
|
+
--debug Debug logging.
|
|
4137
|
+
--dry-run Preview without mutating files or the platform.
|
|
4138
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4139
|
+
process environment. Cannot be combined with --env.
|
|
4140
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
4141
|
+
when stdout is not a terminal.
|
|
4142
|
+
--preview List the preview values instead of the primary ones.
|
|
4143
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4144
|
+
--no-telemetry.
|
|
4145
|
+
|
|
4146
|
+
GLOBAL FLAGS
|
|
4147
|
+
--json Format output as json.
|
|
4148
|
+
|
|
4149
|
+
DESCRIPTION
|
|
4150
|
+
List the variables entered on the project.
|
|
4151
|
+
|
|
4152
|
+
EXAMPLES
|
|
4153
|
+
$ zitadel variable list
|
|
4154
|
+
|
|
4155
|
+
$ zitadel variable list --preview
|
|
4156
|
+
|
|
4157
|
+
$ zitadel variable list --json
|
|
4158
|
+
```
|
|
4159
|
+
|
|
4160
|
+
## `zitadel variable resolve`
|
|
4161
|
+
|
|
4162
|
+
Show the variables the live deployment froze for a target.
|
|
4163
|
+
|
|
4164
|
+
```
|
|
4165
|
+
USAGE
|
|
4166
|
+
$ zitadel variable resolve [--json] [-c <value>] [-s <value>] [-n]
|
|
4167
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4168
|
+
<value>] [--origin <value>] [--plain]
|
|
4169
|
+
|
|
4170
|
+
FLAGS
|
|
4171
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4172
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4173
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4174
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4175
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4176
|
+
an agent.
|
|
4177
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4178
|
+
-v, --verbose Verbose logging.
|
|
4179
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4180
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4181
|
+
--debug Debug logging.
|
|
4182
|
+
--dry-run Preview without mutating files or the platform.
|
|
4183
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4184
|
+
process environment. Cannot be combined with --env.
|
|
4185
|
+
--origin=<value> The origin whose live deployment to read.
|
|
4186
|
+
--plain Tab-separated rows with no header, for piping. Implied
|
|
4187
|
+
when stdout is not a terminal.
|
|
4188
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4189
|
+
--no-telemetry.
|
|
4190
|
+
|
|
4191
|
+
GLOBAL FLAGS
|
|
4192
|
+
--json Format output as json.
|
|
4193
|
+
|
|
4194
|
+
DESCRIPTION
|
|
4195
|
+
Show the variables the live deployment froze for a target.
|
|
4196
|
+
|
|
4197
|
+
EXAMPLES
|
|
4198
|
+
$ zitadel variable resolve
|
|
4199
|
+
|
|
4200
|
+
$ zitadel variable resolve --origin https://app.acme.com
|
|
4201
|
+
|
|
4202
|
+
$ zitadel variable resolve --json
|
|
4203
|
+
```
|
|
4204
|
+
|
|
4205
|
+
## `zitadel variable rm NAME`
|
|
4206
|
+
|
|
4207
|
+
Remove one variable from the project.
|
|
4208
|
+
|
|
4209
|
+
```
|
|
4210
|
+
USAGE
|
|
4211
|
+
$ zitadel variable rm NAME [--json] [-c <value>] [-s <value>] [-n]
|
|
4212
|
+
[--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>] [--env-file
|
|
4213
|
+
<value>] [--preview] [-f]
|
|
4214
|
+
|
|
4215
|
+
ARGUMENTS
|
|
4216
|
+
NAME Variable name to remove.
|
|
4217
|
+
|
|
4218
|
+
FLAGS
|
|
4219
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4220
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4221
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4222
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4223
|
+
-f, --force Remove the variable without the confirmation prompt.
|
|
4224
|
+
Required when non-interactive.
|
|
4225
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4226
|
+
an agent.
|
|
4227
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4228
|
+
-v, --verbose Verbose logging.
|
|
4229
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4230
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4231
|
+
--debug Debug logging.
|
|
4232
|
+
--dry-run Preview without mutating files or the platform.
|
|
4233
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4234
|
+
process environment. Cannot be combined with --env.
|
|
4235
|
+
--preview Remove the preview value alone, leaving the primary
|
|
4236
|
+
one standing.
|
|
4237
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4238
|
+
--no-telemetry.
|
|
4239
|
+
|
|
4240
|
+
GLOBAL FLAGS
|
|
4241
|
+
--json Format output as json.
|
|
4242
|
+
|
|
4243
|
+
DESCRIPTION
|
|
4244
|
+
Remove one variable from the project.
|
|
4245
|
+
|
|
4246
|
+
EXAMPLES
|
|
4247
|
+
$ zitadel variable rm GOOGLE_CLIENT_ID
|
|
4248
|
+
|
|
4249
|
+
$ zitadel variable rm API_URL --preview
|
|
4250
|
+
|
|
4251
|
+
$ zitadel variable rm GOOGLE_CLIENT_ID --force
|
|
4252
|
+
```
|
|
4253
|
+
|
|
4254
|
+
## `zitadel variable set NAME [VALUE]`
|
|
4255
|
+
|
|
4256
|
+
Set one variable on the project.
|
|
4257
|
+
|
|
4258
|
+
```
|
|
4259
|
+
USAGE
|
|
4260
|
+
$ zitadel variable set NAME [VALUE] [--json] [-c <value>] [-s <value>]
|
|
4261
|
+
[-n] [--dry-run] [-v] [--debug] [--color] [--telemetry] [-e <value>]
|
|
4262
|
+
[--env-file <value>] [--secret] [--as string|number|boolean] [--preview]
|
|
4263
|
+
|
|
4264
|
+
ARGUMENTS
|
|
4265
|
+
NAME Variable name (letters, digits and underscores).
|
|
4266
|
+
[VALUE] The value, for a plain (non-secret) variable.
|
|
4267
|
+
|
|
4268
|
+
FLAGS
|
|
4269
|
+
-c, --cwd=<value> Project directory to operate on.
|
|
4270
|
+
-e, --env=<value> Environment to run against, e.g. production. Defaults
|
|
4271
|
+
to ZITADEL_ENV, then the hosting platform's build
|
|
4272
|
+
(VERCEL_ENV, or Netlify's CONTEXT), then development.
|
|
4273
|
+
-n, --non-interactive Disable prompts. Required when scripting or running as
|
|
4274
|
+
an agent.
|
|
4275
|
+
-s, --server=<value> Override the resolved server URL.
|
|
4276
|
+
-v, --verbose Verbose logging.
|
|
4277
|
+
--as=<option> [default: string] Store the value as this JSON type.
|
|
4278
|
+
<options: string|number|boolean>
|
|
4279
|
+
--[no-]color Colorize human output. Disable with --no-color;
|
|
4280
|
+
NO_COLOR and FORCE_COLOR are honored too.
|
|
4281
|
+
--debug Debug logging.
|
|
4282
|
+
--dry-run Preview without mutating files or the platform.
|
|
4283
|
+
--env-file=<value> Read ZITADEL_* values from this file ahead of the
|
|
4284
|
+
process environment. Cannot be combined with --env.
|
|
4285
|
+
--preview Write the preview value alone, leaving the primary one
|
|
4286
|
+
as it is.
|
|
4287
|
+
--secret Store the value encrypted. It can be replaced later
|
|
4288
|
+
but never read back.
|
|
4289
|
+
--[no-]telemetry Send anonymous usage analytics. Disable with
|
|
4290
|
+
--no-telemetry.
|
|
4291
|
+
|
|
4292
|
+
GLOBAL FLAGS
|
|
4293
|
+
--json Format output as json.
|
|
4294
|
+
|
|
4295
|
+
DESCRIPTION
|
|
4296
|
+
Set one variable on the project.
|
|
4297
|
+
|
|
4298
|
+
EXAMPLES
|
|
4299
|
+
$ zitadel variable set GOOGLE_CLIENT_ID 1234.apps.googleusercontent.com
|
|
4300
|
+
|
|
4301
|
+
$ zitadel variable set GOOGLE_CLIENT_SECRET --secret < secret.txt
|
|
4302
|
+
|
|
4303
|
+
$ zitadel variable set SESSION_TTL 3600 --as number
|
|
4304
|
+
|
|
4305
|
+
$ zitadel variable set API_URL https://preview.acme.com --preview
|
|
493
4306
|
```
|
|
494
4307
|
|
|
495
4308
|
## `zitadel version`
|
|
@@ -507,7 +4320,8 @@ GLOBAL FLAGS
|
|
|
507
4320
|
FLAG DESCRIPTIONS
|
|
508
4321
|
--verbose Show additional information about the CLI.
|
|
509
4322
|
|
|
510
|
-
Additionally shows the architecture, node version, operating system, and
|
|
4323
|
+
Additionally shows the architecture, node version, operating system, and
|
|
4324
|
+
versions of plugins that the CLI is using.
|
|
511
4325
|
```
|
|
512
4326
|
|
|
513
4327
|
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/2.2.46/src/commands/version.ts)_
|