Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ Select **y** to proceed with your default tenant, or **N** to choose a different
- [auth0 completion](https://auth0.github.io/auth0-cli/auth0_completion.html) - Setup autocomplete features for this CLI on your terminal
- [auth0 domains](https://auth0.github.io/auth0-cli/auth0_domains.html) - Manage custom domains
- [auth0 email](https://auth0.github.io/auth0-cli/auth0_email.html) - Manage email settings
- [auth0 flows](https://auth0.github.io/auth0-cli/auth0_flows.html) - Manage Flows
- [auth0 forms](https://auth0.github.io/auth0-cli/auth0_forms.html) - Manage Forms
- [auth0 login](https://auth0.github.io/auth0-cli/auth0_login.html) - Authenticate the Auth0 CLI
- [auth0 logout](https://auth0.github.io/auth0-cli/auth0_logout.html) - Log out of a tenant's session
Expand Down
20 changes: 20 additions & 0 deletions docs/auth0_flows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: default
has_toc: false
has_children: true
---
# auth0 flows

Flows let you orchestrate custom logic during authentication and other journeys, chaining actions such as HTTP requests and vault-backed integrations.

## Commands

- [auth0 flows create](auth0_flows_create.md) - Create a new flow
- [auth0 flows delete](auth0_flows_delete.md) - Delete a flow
- [auth0 flows executions](auth0_flows_executions.md) - Manage Flow executions
- [auth0 flows list](auth0_flows_list.md) - List your flows
- [auth0 flows open](auth0_flows_open.md) - Open a flow in the Auth0 Dashboard
- [auth0 flows show](auth0_flows_show.md) - Show a flow
- [auth0 flows update](auth0_flows_update.md) - Update a flow
- [auth0 flows vault](auth0_flows_vault.md) - Manage Flow vault connections

63 changes: 63 additions & 0 deletions docs/auth0_flows_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
layout: default
parent: auth0 flows
has_toc: false
---
# auth0 flows create

Create a new flow.

Interactive behavior: `auth0 flows create` asks only for the name and creates a minimal scaffold; it does not open an editor. Pass `--edit` to open an editor and author the flow actions before it is created, or supply the whole body via `--file` (or piped stdin) with an optional `--name` override. Run `auth0 flows create --example > flow.json` to generate an accepted file payload.

## Usage
```
auth0 flows create [flags]
```

## Examples

```
auth0 flows create
auth0 flows create --name "My Flow"
auth0 flows create --name "My Flow" --edit
auth0 flows create --example > flow.json
auth0 flows create --file ./flow.json
cat flow.json | auth0 flows create -f -
```


## Flags

```
--edit Open an editor to author the flow graph after entering the name.
--example Print an example flow JSON body and exit.
-f, --file string Path to a JSON file with the flow body. Use '-' to read from stdin.
--json Output in json format.
--json-compact Output in compact json format.
--name string Name of the Flow.
```


## Inherited Flags

```
--agent-mode Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 flows create](auth0_flows_create.md) - Create a new flow
- [auth0 flows delete](auth0_flows_delete.md) - Delete a flow
- [auth0 flows executions](auth0_flows_executions.md) - Manage Flow executions
- [auth0 flows list](auth0_flows_list.md) - List your flows
- [auth0 flows open](auth0_flows_open.md) - Open a flow in the Auth0 Dashboard
- [auth0 flows show](auth0_flows_show.md) - Show a flow
- [auth0 flows update](auth0_flows_update.md) - Update a flow
- [auth0 flows vault](auth0_flows_vault.md) - Manage Flow vault connections


59 changes: 59 additions & 0 deletions docs/auth0_flows_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
layout: default
parent: auth0 flows
has_toc: false
---
# auth0 flows delete

Delete a flow.

To delete interactively, use `auth0 flows delete` with no arguments.

To delete non-interactively, supply the flow id and the `--force` flag to skip confirmation.

## Usage
```
auth0 flows delete [flags]
```

## Examples

```
auth0 flows delete
auth0 flows rm
auth0 flows delete <flow-id>
auth0 flows delete <flow-id> --force
auth0 flows delete <flow-id> <flow-id2> <flow-idn>
```


## Flags

```
--force Skip confirmation.
```


## Inherited Flags

```
--agent-mode Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 flows create](auth0_flows_create.md) - Create a new flow
- [auth0 flows delete](auth0_flows_delete.md) - Delete a flow
- [auth0 flows executions](auth0_flows_executions.md) - Manage Flow executions
- [auth0 flows list](auth0_flows_list.md) - List your flows
- [auth0 flows open](auth0_flows_open.md) - Open a flow in the Auth0 Dashboard
- [auth0 flows show](auth0_flows_show.md) - Show a flow
- [auth0 flows update](auth0_flows_update.md) - Update a flow
- [auth0 flows vault](auth0_flows_vault.md) - Manage Flow vault connections


15 changes: 15 additions & 0 deletions docs/auth0_flows_executions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: default
has_toc: false
has_children: true
---
# auth0 flows executions

Inspect the runtime executions produced when a flow runs.

## Commands

- [auth0 flows executions delete](auth0_flows_executions_delete.md) - Delete a flow execution
- [auth0 flows executions list](auth0_flows_executions_list.md) - List a flow's executions
- [auth0 flows executions show](auth0_flows_executions_show.md) - Show a flow execution

50 changes: 50 additions & 0 deletions docs/auth0_flows_executions_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: default
parent: auth0 flows executions
has_toc: false
---
# auth0 flows executions delete

Delete one or more executions of a flow.

Supply the flow id followed by the execution ids. Use `--force` to skip confirmation.

## Usage
```
auth0 flows executions delete [flags]
```

## Examples

```
auth0 flows executions delete <flow-id> <execution-id>
auth0 flows executions rm <flow-id> <execution-id> --force
auth0 flows executions delete <flow-id> <execution-id> <execution-id2>
```


## Flags

```
--force Skip confirmation.
```


## Inherited Flags

```
--agent-mode Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 flows executions delete](auth0_flows_executions_delete.md) - Delete a flow execution
- [auth0 flows executions list](auth0_flows_executions_list.md) - List a flow's executions
- [auth0 flows executions show](auth0_flows_executions_show.md) - Show a flow execution


53 changes: 53 additions & 0 deletions docs/auth0_flows_executions_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
layout: default
parent: auth0 flows executions
has_toc: false
---
# auth0 flows executions list

List the executions produced by a flow.

## Usage
```
auth0 flows executions list [flags]
```

## Examples

```
auth0 flows executions list <flow-id>
auth0 flows executions ls <flow-id> --number 100
auth0 flows executions list <flow-id> --json
```


## Flags

```
--csv Output in csv format.
--from string Cursor id from which to start selection.
--json Output in json format.
--json-compact Output in compact json format.
-n, --number int Number of executions to retrieve. Fetched across pages. (default 100)
--take int Number of executions to retrieve per page.
```


## Inherited Flags

```
--agent-mode Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 flows executions delete](auth0_flows_executions_delete.md) - Delete a flow execution
- [auth0 flows executions list](auth0_flows_executions_list.md) - List a flow's executions
- [auth0 flows executions show](auth0_flows_executions_show.md) - Show a flow execution


48 changes: 48 additions & 0 deletions docs/auth0_flows_executions_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: default
parent: auth0 flows executions
has_toc: false
---
# auth0 flows executions show

Display information about a flow execution.

## Usage
```
auth0 flows executions show [flags]
```

## Examples

```
auth0 flows executions show <flow-id> <execution-id>
auth0 flows executions show <flow-id> <execution-id> --json
```


## Flags

```
--json Output in json format.
--json-compact Output in compact json format.
```


## Inherited Flags

```
--agent-mode Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 flows executions delete](auth0_flows_executions_delete.md) - Delete a flow execution
- [auth0 flows executions list](auth0_flows_executions_list.md) - List a flow's executions
- [auth0 flows executions show](auth0_flows_executions_show.md) - Show a flow execution


60 changes: 60 additions & 0 deletions docs/auth0_flows_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
layout: default
parent: auth0 flows
has_toc: false
---
# auth0 flows list

List your existing flows. To create one, run: `auth0 flows create`.

## Usage
```
auth0 flows list [flags]
```

## Examples

```
auth0 flows list
auth0 flows ls
auth0 flows ls --number 100
auth0 flows ls --hydrate
auth0 flows ls --json
```


## Flags

```
--csv Output in csv format.
--hydrate Hydrate the response with the number of forms referencing each flow.
--json Output in json format.
--json-compact Output in compact json format.
-n, --number int Number of flows to retrieve. Fetched across pages. (default 100)
--synchronous Filter to synchronous (true) or asynchronous (false) flows.
```


## Inherited Flags

```
--agent-mode Output JSON, disable prompts and colors. Auto-enabled for AI agents; set AUTH0_AGENT_MODE=false to disable.
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 flows create](auth0_flows_create.md) - Create a new flow
- [auth0 flows delete](auth0_flows_delete.md) - Delete a flow
- [auth0 flows executions](auth0_flows_executions.md) - Manage Flow executions
- [auth0 flows list](auth0_flows_list.md) - List your flows
- [auth0 flows open](auth0_flows_open.md) - Open a flow in the Auth0 Dashboard
- [auth0 flows show](auth0_flows_show.md) - Show a flow
- [auth0 flows update](auth0_flows_update.md) - Update a flow
- [auth0 flows vault](auth0_flows_vault.md) - Manage Flow vault connections


Loading
Loading