zitadel api
Call any operation of the Zitadel API, with this project's server and project secret.
Usage
npx @zitadel/cli@latest api [<operation>] [flags]Arguments
| Argument | Description |
|---|---|
<operation> | An operationId (queryUsers) or a path (/users/query), then the path parameters. Omit it to choose one. |
Flags
| Flag | Description |
|---|---|
-X, --method <value> | The HTTP method, to choose among a path's operations. |
-F, --field <value> | A field: name=value, or name:=json for JSON, typed by the operation's schema. A query parameter's name sets it; any other name is a dot path into the body. Repeatable. Can be given more than once. |
--input <value> | Read the JSON body from a file, or from stdin with -. --field lays over it. |
--paginate | Follow next_page_token to the last page, and answer with every page's items in one list. |
It also takes the global flags.
Examples
npx @zitadel/cli@latest api queryUsers -F limit=5
npx @zitadel/cli@latest api GetUserByID user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W
npx @zitadel/cli@latest api /users/user_01JZ8Y3V4Q0K7N2M5P6R8S9T0W/passkeys --json
npx @zitadel/cli@latest api listEvents -F category=auth --paginate --json
npx @zitadel/cli@latest api createTeam -F name=Support --dry-run
npx @zitadel/cli@latest api createTeam --input - < team.jsonWas this helpful?