Skip to content
Merged
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 @@ -274,6 +274,7 @@ Select **y** to proceed with your default tenant, or **N** to choose a different
- [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
- [auth0 logs](https://auth0.github.io/auth0-cli/auth0_logs.html) - View tenant logs
Expand Down
20 changes: 20 additions & 0 deletions docs/auth0_forms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
layout: default
has_toc: false
has_children: true
---
# auth0 forms

Forms are customizable screens you can insert into a flow to collect input from users during authentication and other journeys.

## Commands

- [auth0 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form

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

Create a new form.

Interactive behavior: `auth0 forms create` asks for the name, then offers to author the form body in an editor. Decline the prompt to create a minimal scaffold and refine it in the dashboard builder instead.

Alternatively, supply the whole body via `--data` as inline JSON, a file (`@form.json`), or piped stdin. Run `auth0 forms create --schema` to print the accepted payload schema and `auth0 forms create --example > form.json` to generate a starter body.

`--data` provides the whole payload and cannot be combined with `--name` or the `--language-*` flags; it is checked for valid JSON and a form name before it is sent, and the form graph itself is validated by the API.

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

## Examples

```
auth0 forms create
auth0 forms create --name "My Form"
auth0 forms create --example > form.json
auth0 forms create --schema
auth0 forms create --data '{"name":"My Form"}'
auth0 forms create --data @form.json
cat form.json | auth0 forms create
```


## Flags

```
--data string JSON payload for the operation, as a JSON string or file path (@file.json). Can also be piped via stdin.
--example Print an example form JSON body and exit.
--json Output in json format.
--json-compact Output in compact json format.
--language-default string Default language of the Form (e.g. en).
--language-primary string Primary language of the Form (e.g. en).
--name string Name of the Form.
--schema Print the request payload schema for this command and exit. Use with --json or --json-compact for machine-readable output.
```


## 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 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form


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

Delete a form.

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

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

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

## Examples

```
auth0 forms delete
auth0 forms rm
auth0 forms delete <form-id>
auth0 forms delete <form-id> --force
auth0 forms delete <form-id> <form-id2> <form-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 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form


55 changes: 55 additions & 0 deletions docs/auth0_forms_export.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
layout: default
parent: auth0 forms
has_toc: false
---
# auth0 forms export

Export a form as JSON. Writes to stdout by default (pipe-friendly) or to a file with `--output`. The output uses the same envelope as the Auth0 Dashboard (`version`, `form`, `flows`, `connections`), bundling the flows and vault connections the form references with portable `#FLOW-N#`/`#CONN-N#` placeholders, so it can be imported by the CLI or opened in the Dashboard.

## Usage
```
auth0 forms export [flags]
```

## Examples

```
auth0 forms export <form-id>
auth0 forms export <form-id> --output ./form.json
auth0 forms export <form-id> --json-compact
auth0 forms export <form-id> | auth0 forms import
```


## Flags

```
--json-compact Output in compact json format.
-o, --output string Path to write the exported form. Writes to stdout when omitted.
```


## 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 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form


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

Import a form from `--data`, given as inline JSON, a file (`@form.json`), or piped stdin. Without `--id` a new form is created; with `--id` the existing form is replaced.

Both a flat form graph and the Dashboard envelope (`version`, `form`, `flows`, `connections`) are accepted. For an envelope, the bundled flows are created and each `#CONN-N#` connection placeholder is mapped to an existing vault connection, either interactively or with `--connection`.

## Usage
```
auth0 forms import [flags]
```

## Examples

```
auth0 forms import --data @form.json
auth0 forms import --data @form.json --id <form-id>
auth0 forms import --data @form.json --connection '#CONN-1#=ac_123'
auth0 forms export <form-id> | auth0 forms import
```


## Flags

```
--connection stringToString Map an exported connection placeholder to an existing vault connection ID, e.g. --connection '#CONN-1#=ac_123'. Repeatable. (default [])
--data string JSON payload for the operation, as a JSON string or file path (@file.json). Can also be piped via stdin.
--id string Id of an existing Form to replace. When omitted, a new form is created.
--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 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form


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

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

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

## Examples

```
auth0 forms list
auth0 forms ls
auth0 forms ls --number 100
auth0 forms ls --json
auth0 forms ls --csv
```


## Flags

```
--csv Output in csv format.
--json Output in json format.
--json-compact Output in compact json format.
-n, --number int Number of forms to retrieve. Fetched across pages. (default 100)
```


## 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 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form


47 changes: 47 additions & 0 deletions docs/auth0_forms_open.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: default
parent: auth0 forms
has_toc: false
---
# auth0 forms open

Open a form's page in the Auth0 Dashboard form builder.

## Usage
```
auth0 forms open [flags]
```

## Examples

```
auth0 forms open
auth0 forms open <form-id>
```




## 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 forms create](auth0_forms_create.md) - Create a new form
- [auth0 forms delete](auth0_forms_delete.md) - Delete a form
- [auth0 forms export](auth0_forms_export.md) - Export a form
- [auth0 forms import](auth0_forms_import.md) - Import a form
- [auth0 forms list](auth0_forms_list.md) - List your forms
- [auth0 forms open](auth0_forms_open.md) - Open a form in the Auth0 Dashboard
- [auth0 forms show](auth0_forms_show.md) - Show a form
- [auth0 forms update](auth0_forms_update.md) - Update a form


Loading
Loading