Merge branch 'v1' of https://github.com/auth0/auth0-cli into v1

auth0 · Jan 3, 2023 · 494cbf3 · 494cbf3
2 parents 8b97922 + 541ff5c
commit 494cbf3
Show file tree

Hide file tree

Showing 128 changed files with 2,249 additions and 2,414 deletions.
diff --git a/docs/auth0_actions.md b/docs/auth0_actions.md
@@ -1,37 +1,17 @@
 ---
 layout: default
 ---
-## auth0 actions
+# auth0 actions
 
-Manage resources for actions
+Actions are secure, tenant-specific, versioned functions written in Node.js that execute at certain points within the Auth0 platform. Actions are used to customize and extend Auth0's capabilities with custom logic.
 
-### Synopsis
+## Commands
 
-Manage resources for actions.
-
-### Options
-
-```
-  -h, --help   help for actions
-```
-
-### Options inherited from parent commands
-
-```
-      --debug           Enable debug mode.
-      --no-color        Disable colors.
-      --no-input        Disable interactivity.
-      --tenant string   Specific tenant to use.
-```
-
-### SEE ALSO
-
-* [auth0](/auth0-cli/)	 - Build, manage and test your Auth0 integrations from the command line.
-* [auth0 actions create](auth0_actions_create.md)	 - Create a new action
-* [auth0 actions delete](auth0_actions_delete.md)	 - Delete an action
-* [auth0 actions deploy](auth0_actions_deploy.md)	 - Deploy an action
-* [auth0 actions list](auth0_actions_list.md)	 - List your actions
-* [auth0 actions open](auth0_actions_open.md)	 - Open action details page in the Auth0 Dashboard
-* [auth0 actions show](auth0_actions_show.md)	 - Show an action
-* [auth0 actions update](auth0_actions_update.md)	 - Update an action
+- [auth0 actions create](auth0_actions_create.md) - Create a new action
+- [auth0 actions delete](auth0_actions_delete.md) - Delete an action
+- [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action
+- [auth0 actions list](auth0_actions_list.md) - List your actions
+- [auth0 actions open](auth0_actions_open.md) - Open the settings page of an action
+- [auth0 actions show](auth0_actions_show.md) - Show an action
+- [auth0 actions update](auth0_actions_update.md) - Update an action
 
diff --git a/docs/auth0_actions_create.md b/docs/auth0_actions_create.md
@@ -1,41 +1,32 @@
 ---
 layout: default
 ---
-## auth0 actions create
+# auth0 actions create
 
-Create a new action
+Create a new action.
 
-### Synopsis
+To create interactively, use `auth0 actions create` with no flags.
 
-Create a new action.
+To create non-interactively, supply the action name, trigger, secrets and dependencies through the flags.
 
 ```
 auth0 actions create [flags]
 ```
 
-### Examples
-
-```
-auth0 actions create 
-auth0 actions create --name myaction
-auth0 actions create -n myaction --trigger post-login
-auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -d "uuid=8.0.0"
-auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -s "API_KEY=value" -s "SECRET=value
-```
 
-### Options
+## Flags
 
 ```
   -c, --code string                 Code content for the action.
-  -d, --dependency stringToString   Third party npm module, and it version, that the action depends on. (default [])
-  -h, --help                        help for create
+  -d, --dependency stringToString   Third party npm module, and its version, that the action depends on. (default [])
       --json                        Output in json format.
   -n, --name string                 Name of the action.
-  -s, --secret stringToString       Secret to be used in the action. (default [])
+  -s, --secret stringToString       Secrets to be used in the action. (default [])
   -t, --trigger string              Trigger of the action. At this time, an action can only target a single trigger at a time.
 ```
 
-### Options inherited from parent commands
+
+## InheritedFlags
 
 ```
       --debug           Enable debug mode.
@@ -44,7 +35,25 @@ auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -s "API_KEY=val
       --tenant string   Specific tenant to use.
 ```
 
-### SEE ALSO
+## Examples
+
+```
+  auth0 actions create
+  auth0 actions create --name myaction
+  auth0 actions create -n myaction --trigger post-login
+  auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -d "uuid=9.0.0"
+  auth0 actions create -n myaction -t post-login -d "lodash=4.0.0" -s "API_KEY=value" -s "SECRET=value
+```
+
+
+## Related Commands
+
+- [auth0 actions create](auth0_actions_create.md) - Create a new action
+- [auth0 actions delete](auth0_actions_delete.md) - Delete an action
+- [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action
+- [auth0 actions list](auth0_actions_list.md) - List your actions
+- [auth0 actions open](auth0_actions_open.md) - Open the settings page of an action
+- [auth0 actions show](auth0_actions_show.md) - Show an action
+- [auth0 actions update](auth0_actions_update.md) - Update an action
 
-* [auth0 actions](auth0_actions.md)	 - Manage resources for actions
 
diff --git a/docs/auth0_actions_delete.md b/docs/auth0_actions_delete.md
@@ -1,33 +1,27 @@
 ---
 layout: default
 ---
-## auth0 actions delete
+# auth0 actions delete
 
-Delete an action
+Delete an action.
 
-### Synopsis
+To delete interactively, use `auth0 actions delete` with no arguments.
 
-Delete an action.
+To delete non-interactively, supply the action id and the `--force` flag to skip confirmation.
 
 ```
 auth0 actions delete [flags]
 ```
 
-### Examples
-
-```
-auth0 actions delete 
-auth0 actions delete <id>
-```
 
-### Options
+## Flags
 
 ```
       --force   Skip confirmation.
-  -h, --help    help for delete
 ```
 
-### Options inherited from parent commands
+
+## InheritedFlags
 
 ```
       --debug           Enable debug mode.
@@ -36,7 +30,23 @@ auth0 actions delete <id>
       --tenant string   Specific tenant to use.
 ```
 
-### SEE ALSO
+## Examples
+
+```
+  auth0 actions delete
+  auth0 actions delete <id>
+  auth0 actions delete <id> --force
+```
+
+
+## Related Commands
+
+- [auth0 actions create](auth0_actions_create.md) - Create a new action
+- [auth0 actions delete](auth0_actions_delete.md) - Delete an action
+- [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action
+- [auth0 actions list](auth0_actions_list.md) - List your actions
+- [auth0 actions open](auth0_actions_open.md) - Open the settings page of an action
+- [auth0 actions show](auth0_actions_show.md) - Show an action
+- [auth0 actions update](auth0_actions_update.md) - Update an action
 
-* [auth0 actions](auth0_actions.md)	 - Manage resources for actions
 
diff --git a/docs/auth0_actions_deploy.md b/docs/auth0_actions_deploy.md
@@ -1,33 +1,25 @@
 ---
 layout: default
 ---
-## auth0 actions deploy
+# auth0 actions deploy
 
-Deploy an action
+Before an action can be bound to a flow, the action must be deployed.
 
-### Synopsis
-
-Deploy an action.
+The selected action will be deployed and added to the collection of available actions for flows. Additionally, a new draft version of the deployed action will be created for future editing. Because secrets and dependencies are tied to versions, any saved secrets or dependencies will be available to the new draft.
 
 ```
 auth0 actions deploy [flags]
 ```
 
-### Examples
-
-```
-auth0 actions deploy 
-auth0 actions deploy <id>
-```
 
-### Options
+## Flags
 
 ```
-  -h, --help   help for deploy
       --json   Output in json format.
 ```
 
-### Options inherited from parent commands
+
+## InheritedFlags
 
 ```
       --debug           Enable debug mode.
@@ -36,7 +28,23 @@ auth0 actions deploy <id>
       --tenant string   Specific tenant to use.
 ```
 
-### SEE ALSO
+## Examples
+
+```
+  auth0 actions deploy
+  auth0 actions deploy <id>
+  auth0 actions deploy <id> --json
+```
+
+
+## Related Commands
+
+- [auth0 actions create](auth0_actions_create.md) - Create a new action
+- [auth0 actions delete](auth0_actions_delete.md) - Delete an action
+- [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action
+- [auth0 actions list](auth0_actions_list.md) - List your actions
+- [auth0 actions open](auth0_actions_open.md) - Open the settings page of an action
+- [auth0 actions show](auth0_actions_show.md) - Show an action
+- [auth0 actions update](auth0_actions_update.md) - Update an action
 
-* [auth0 actions](auth0_actions.md)	 - Manage resources for actions
 
diff --git a/docs/auth0_actions_list.md b/docs/auth0_actions_list.md
@@ -1,34 +1,23 @@
 ---
 layout: default
 ---
-## auth0 actions list
+# auth0 actions list
 
-List your actions
-
-### Synopsis
-
-List your existing actions. To create one try:
-auth0 actions create
+List your existing actions. To create one, run: `auth0 actions create`.
 
 ```
 auth0 actions list [flags]
 ```
 
-### Examples
-
-```
-auth0 actions list
-auth0 actions ls
-```
 
-### Options
+## Flags
 
 ```
-  -h, --help   help for list
       --json   Output in json format.
 ```
 
-### Options inherited from parent commands
+
+## InheritedFlags
 
 ```
       --debug           Enable debug mode.
@@ -37,7 +26,23 @@ auth0 actions ls
       --tenant string   Specific tenant to use.
 ```
 
-### SEE ALSO
+## Examples
+
+```
+  auth0 actions list
+  auth0 actions ls
+  auth0 actions ls --json
+```
+
+
+## Related Commands
+
+- [auth0 actions create](auth0_actions_create.md) - Create a new action
+- [auth0 actions delete](auth0_actions_delete.md) - Delete an action
+- [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action
+- [auth0 actions list](auth0_actions_list.md) - List your actions
+- [auth0 actions open](auth0_actions_open.md) - Open the settings page of an action
+- [auth0 actions show](auth0_actions_show.md) - Show an action
+- [auth0 actions update](auth0_actions_update.md) - Update an action
 
-* [auth0 actions](auth0_actions.md)	 - Manage resources for actions
 
diff --git a/docs/auth0_actions_open.md b/docs/auth0_actions_open.md
@@ -1,31 +1,18 @@
 ---
 layout: default
 ---
-## auth0 actions open
+# auth0 actions open
 
-Open action details page in the Auth0 Dashboard
-
-### Synopsis
-
-Open action details page in the Auth0 Dashboard.
+Open an action's settings page in the Auth0 Dashboard.
 
 ```
 auth0 actions open [flags]
 ```
 
-### Examples
 
-```
-auth0 actions open <id>
-```
 
-### Options
-
-```
-  -h, --help   help for open
-```
 
-### Options inherited from parent commands
+## InheritedFlags
 
 ```
       --debug           Enable debug mode.
@@ -34,7 +21,22 @@ auth0 actions open <id>
       --tenant string   Specific tenant to use.
 ```
 
-### SEE ALSO
+## Examples
+
+```
+  auth0 actions open
+  auth0 actions open <id>
+```
+
+
+## Related Commands
+
+- [auth0 actions create](auth0_actions_create.md) - Create a new action
+- [auth0 actions delete](auth0_actions_delete.md) - Delete an action
+- [auth0 actions deploy](auth0_actions_deploy.md) - Deploy an action
+- [auth0 actions list](auth0_actions_list.md) - List your actions
+- [auth0 actions open](auth0_actions_open.md) - Open the settings page of an action
+- [auth0 actions show](auth0_actions_show.md) - Show an action
+- [auth0 actions update](auth0_actions_update.md) - Update an action
 
-* [auth0 actions](auth0_actions.md)	 - Manage resources for actions