Update docs

auth0 · Jan 8, 2023 · 7c67aff · 7c67aff
1 parent abb6b2e
commit 7c67aff
Show file tree

Hide file tree

Showing 116 changed files with 1,383 additions and 1,034 deletions.
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 </div>
 
-Build, manage and test your [Auth0](http://auth0.com/) integrations from the command line.
+Build, manage and test your [Auth0](https://auth0.com/) integrations from the command line.
 
 ![demo](./demo.gif)
 
@@ -30,7 +30,7 @@ Build, manage and test your [Auth0](http://auth0.com/) integrations from the com
 Install via [Homebrew](https://brew.sh/):
 
 ```bash
- brew tap auth0/auth0-cli && brew install auth0
+brew tap auth0/auth0-cli && brew install auth0
 ```
 
 ### Windows

diff --git a/docs/auth0_actions_create.md b/docs/auth0_actions_create.md
@@ -7,12 +7,26 @@ Create a new action.
 
 To create interactively, use `auth0 actions create` with no flags.
 
-To create non-interactively, supply the action name, trigger, secrets and dependencies through the flags.
+To create non-interactively, supply the action name, trigger, code, secrets and dependencies through the flags.
 
+## Usage
 ```
 auth0 actions create [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions create
+  auth0 actions create --name myaction
+  auth0 actions create --name myaction --trigger post-login
+  auth0 actions create --name myaction --trigger post-login --code "$(cat path/to/code.js)"
+  auth0 actions create --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0"
+  auth0 actions create --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" --secret "SECRET=value"
+  auth0 actions create --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" --dependency "uuid=9.0.0" --secret "API_KEY=value" --secret "SECRET=value"
+  auth0 actions create -n myaction -t post-login -c "$(cat path/to/code.js)" -d "lodash=4.0.0" -d "uuid=9.0.0" -s "API_KEY=value" -s "SECRET=value" --json
+```
+
 
 ## Flags
 
@@ -35,16 +49,6 @@ auth0 actions create [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## 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
 

diff --git a/docs/auth0_actions_delete.md b/docs/auth0_actions_delete.md
@@ -9,10 +9,20 @@ To delete interactively, use `auth0 actions delete` with no arguments.
 
 To delete non-interactively, supply the action id and the `--force` flag to skip confirmation.
 
+## Usage
 ```
 auth0 actions delete [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions delete
+  auth0 actions rm
+  auth0 actions delete <action-id>
+  auth0 actions delete <action-id> --force
+```
+
 
 ## Flags
 
@@ -30,14 +40,6 @@ auth0 actions delete [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 actions delete
-  auth0 actions delete <id>
-  auth0 actions delete <id> --force
-```
-
 
 ## Related Commands
 

diff --git a/docs/auth0_actions_deploy.md b/docs/auth0_actions_deploy.md
@@ -7,10 +7,19 @@ Before an action can be bound to a flow, the action must be deployed.
 
 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.
 
+## Usage
 ```
 auth0 actions deploy [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions deploy
+  auth0 actions deploy <action-id>
+  auth0 actions deploy <action-id> --json
+```
+
 
 ## Flags
 
@@ -28,14 +37,6 @@ auth0 actions deploy [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 actions deploy
-  auth0 actions deploy <id>
-  auth0 actions deploy <id> --json
-```
-
 
 ## Related Commands
 

diff --git a/docs/auth0_actions_list.md b/docs/auth0_actions_list.md
@@ -5,10 +5,19 @@ layout: default
 
 List your existing actions. To create one, run: `auth0 actions create`.
 
+## Usage
 ```
 auth0 actions list [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions list
+  auth0 actions ls
+  auth0 actions ls --json
+```
+
 
 ## Flags
 
@@ -26,14 +35,6 @@ auth0 actions list [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 actions list
-  auth0 actions ls
-  auth0 actions ls --json
-```
-
 
 ## Related Commands
 

diff --git a/docs/auth0_actions_open.md b/docs/auth0_actions_open.md
@@ -5,10 +5,18 @@ layout: default
 
 Open an action's settings page in the Auth0 Dashboard.
 
+## Usage
 ```
 auth0 actions open [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions open
+  auth0 actions open <action-id>
+```
+
 
 
 
@@ -21,13 +29,6 @@ auth0 actions open [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 actions open
-  auth0 actions open <id>
-```
-
 
 ## Related Commands
 

diff --git a/docs/auth0_actions_show.md b/docs/auth0_actions_show.md
@@ -5,10 +5,19 @@ layout: default
 
 Display the name, type, status, code and other information about an action.
 
+## Usage
 ```
 auth0 actions show [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions show
+  auth0 actions show <action-id>
+  auth0 actions show <action-id> --json
+```
+
 
 ## Flags
 
@@ -26,14 +35,6 @@ auth0 actions show [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 actions show
-  auth0 actions show <id>
-  auth0 actions show <id> --json
-```
-
 
 ## Related Commands
 

diff --git a/docs/auth0_actions_update.md b/docs/auth0_actions_update.md
@@ -9,10 +9,25 @@ To update interactively, use `auth0 actions update` with no arguments.
 
 To update non-interactively, supply the action id, name, trigger, secrets and dependencies through the flags.
 
+## Usage
 ```
 auth0 actions update [flags]
 ```
 
+## Examples
+
+```
+  auth0 actions update <action-id> 
+  auth0 actions update <action-id> --name myaction
+  auth0 actions update <action-id> --name myaction --trigger post-login
+  auth0 actions update <action-id> --name myaction --trigger post-login --code "$(cat path/to/code.js)"
+  auth0 actions update <action-id> --name myaction --trigger post-login --code "$(cat path/to/code.js)"
+  auth0 actions update <action-id> --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0"
+  auth0 actions update <action-id> --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" --secret "SECRET=value"
+  auth0 actions update <action-id> --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" --dependency "uuid=9.0.0" --secret "API_KEY=value" --secret "SECRET=value"
+  auth0 actions update <action-id> -n myaction -t post-login -c "$(cat path/to/code.js)" -d "lodash=4.0.0" -d "uuid=9.0.0" -s "API_KEY=value" -s "SECRET=value" --json
+```
+
 
 ## Flags
 
@@ -35,16 +50,6 @@ auth0 actions update [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 actions update <id> 
-  auth0 actions update <id> --name myaction
-  auth0 actions update <id> -n myaction --trigger post-login
-  auth0 actions update <id> -n myaction -t post-login -d "lodash=4.0.0" -d "uuid=9.0.0"
-  auth0 actions update <id> -n myaction -t post-login -d "lodash=4.0.0" -s "API_KEY=value" -s "SECRET=value
-```
-
 
 ## Related Commands
 

diff --git a/docs/auth0_api.md b/docs/auth0_api.md
@@ -3,20 +3,25 @@ layout: default
 ---
 # auth0 api
 
-Makes an authenticated HTTP request to the Auth0 Management API and returns the response as JSON.
+Makes an authenticated HTTP request to the [Auth0 Management API](https://auth0.com/docs/api/management/v2) and returns the response as JSON.
 
-Method argument is optional, defaults to GET for requests without data and POST for requests with data.
+Method argument is optional, defaults to `GET` for requests without data and `POST` for requests with data.
 
-Additional scopes may need to be requested during authentication step via the `--scopes` flag. Ex: `auth0 login --scopes read:client_grants`.
+Additional scopes may need to be requested during authentication step via the `--scopes` flag. For example: `auth0 login --scopes read:client_grants`.
 
-Auth0 Management API Docs:
-  https://auth0.com/docs/api/management/v2
+## Usage
+```
+auth0 api <method> <url-path> [flags]
+```
 
-Available Methods:
-  get, post, put, patch, delete
+## Examples
 
 ```
-auth0 api <method> <url-path> [flags]
+  auth0 api get "tenants/settings"
+  auth0 api "stats/daily" -q "from=20221101" -q "to=20221118"
+  auth0 api delete "actions/actions/<action-id>" --force
+  auth0 api clients --data "{\"name\":\"ssoTest\",\"app_type\":\"sso_integration\"}"
+  cat data.json | auth0 api post clients
 ```
 
 
@@ -38,13 +43,4 @@ auth0 api <method> <url-path> [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 api "stats/daily" -q "from=20221101" -q "to=20221118"
-  auth0 api get "tenants/settings"
-  auth0 api clients --data "{\"name\":\"ssoTest\",\"app_type\":\"sso_integration\"}"
-  cat data.json | auth0 api post clients
-```
-
 
diff --git a/docs/auth0_apis_create.md b/docs/auth0_apis_create.md
@@ -9,10 +9,23 @@ To create interactively, use `auth0 apis create` with no flags.
 
 To create non-interactively, supply the name, identifier, scopes, token lifetime and whether to allow offline access through the flags.
 
+## Usage
 ```
 auth0 apis create [flags]
 ```
 
+## Examples
+
+```
+  auth0 apis create 
+  auth0 apis create --name myapi
+  auth0 apis create --name myapi --identifier http://my-api
+  auth0 apis create --name myapi --identifier http://my-api --token-lifetime 6100
+  auth0 apis create --name myapi --identifier http://my-api --token-lifetime 6100 --offline-access
+  auth0 apis create --name myapi --identifier http://my-api --token-lifetime 6100 --offline-access false --scopes "letter:write,letter:read"
+  auth0 apis create -n myapi -i http://my-api -t 6100 -o false -s "letter:write,letter:read" --json
+```
+
 
 ## Flags
 
@@ -35,16 +48,6 @@ auth0 apis create [flags]
       --tenant string   Specific tenant to use.
 ```
 
-## Examples
-
-```
-  auth0 apis create 
-  auth0 apis create --name myapi
-  auth0 apis create -n myapi --identifier http://my-api
-  auth0 apis create -n myapi --token-expiration 6100
-  auth0 apis create -n myapi -e 6100 --offline-access=true
-```
-
 
 ## Related Commands