From e644f307ef6f22646a2d64a55e48333315e2b65d Mon Sep 17 00:00:00 2001 From: Sergiu Ghitea Date: Sun, 8 Jan 2023 18:25:31 +0100 Subject: [PATCH] Update docs --- README.md | 4 +- docs/auth0_actions_create.md | 26 ++++--- docs/auth0_actions_delete.md | 18 +++-- docs/auth0_actions_deploy.md | 17 ++-- docs/auth0_actions_list.md | 17 ++-- docs/auth0_actions_open.md | 15 ++-- docs/auth0_actions_show.md | 17 ++-- docs/auth0_actions_update.md | 24 +++--- docs/auth0_api.md | 30 ++++---- docs/auth0_apis_create.md | 23 +++--- docs/auth0_apis_delete.md | 18 +++-- docs/auth0_apis_list.md | 19 ++--- docs/auth0_apis_open.md | 15 ++-- docs/auth0_apis_scopes_list.md | 17 ++-- docs/auth0_apis_show.md | 17 ++-- docs/auth0_apis_update.md | 23 +++--- docs/auth0_apps_create.md | 22 +++--- docs/auth0_apps_delete.md | 17 ++-- docs/auth0_apps_list.md | 20 ++--- docs/auth0_apps_open.md | 15 ++-- docs/auth0_apps_show.md | 18 +++-- docs/auth0_apps_update.md | 21 ++--- docs/auth0_apps_use.md | 17 ++-- docs/auth0_completion.md | 77 +++++++++++++------ docs/auth0_domains_create.md | 20 +++-- docs/auth0_domains_delete.md | 18 +++-- docs/auth0_domains_list.md | 17 ++-- docs/auth0_domains_show.md | 17 ++-- docs/auth0_domains_update.md | 18 +++-- docs/auth0_domains_verify.md | 15 ++-- docs/auth0_email_templates_show.md | 16 ++-- docs/auth0_email_templates_update.md | 24 ++++-- docs/auth0_ips_check.md | 15 ++-- docs/auth0_ips_unblock.md | 15 ++-- docs/auth0_login.md | 17 ++-- docs/auth0_logout.md | 15 ++-- docs/auth0_logs_list.md | 27 +++---- docs/auth0_logs_streams_create.md | 33 ++++---- docs/auth0_logs_streams_delete.md | 18 +++-- docs/auth0_logs_streams_list.md | 17 ++-- docs/auth0_logs_streams_open.md | 15 ++-- docs/auth0_logs_streams_show.md | 17 ++-- docs/auth0_logs_streams_update.md | 32 ++++---- docs/auth0_logs_tail.md | 27 +++---- docs/auth0_orgs_create.md | 21 ++--- docs/auth0_orgs_delete.md | 17 ++-- docs/auth0_orgs_list.md | 19 ++--- docs/auth0_orgs_members_list.md | 18 +++-- docs/auth0_orgs_open.md | 15 ++-- docs/auth0_orgs_roles_list.md | 18 +++-- docs/auth0_orgs_roles_members_list.md | 19 +++-- docs/auth0_orgs_show.md | 17 ++-- docs/auth0_orgs_update.md | 19 ++--- ...ection_breached-password-detection_show.md | 15 ++-- ...tion_breached-password-detection_update.md | 19 +++-- ..._protection_brute-force-protection_show.md | 15 ++-- ...rotection_brute-force-protection_update.md | 20 +++-- ...rotection_suspicious-ip-throttling_show.md | 15 ++-- ...tection_suspicious-ip-throttling_update.md | 18 +++-- docs/auth0_quickstarts_download.md | 15 ++-- docs/auth0_quickstarts_list.md | 21 ++--- docs/auth0_roles_create.md | 17 ++-- docs/auth0_roles_delete.md | 18 +++-- docs/auth0_roles_list.md | 19 ++--- docs/auth0_roles_permissions_add.md | 22 +++--- docs/auth0_roles_permissions_list.md | 17 ++-- docs/auth0_roles_permissions_remove.md | 21 ++--- docs/auth0_roles_show.md | 17 ++-- docs/auth0_roles_update.md | 18 +++-- docs/auth0_rules_create.md | 22 +++--- docs/auth0_rules_delete.md | 18 +++-- docs/auth0_rules_disable.md | 16 ++-- docs/auth0_rules_enable.md | 16 ++-- docs/auth0_rules_list.md | 17 ++-- docs/auth0_rules_show.md | 17 ++-- docs/auth0_rules_update.md | 26 ++++--- docs/auth0_tenants_list.md | 13 ++-- docs/auth0_tenants_open.md | 15 ++-- docs/auth0_tenants_use.md | 15 ++-- docs/auth0_test_login.md | 23 ++++-- docs/auth0_test_token.md | 19 +++-- docs/auth0_universal-login_prompts_show.md | 15 ++-- docs/auth0_universal-login_prompts_update.md | 15 ++-- docs/auth0_universal-login_show.md | 16 ++-- docs/auth0_universal-login_templates_show.md | 16 ++-- .../auth0_universal-login_templates_update.md | 14 ++-- docs/auth0_universal-login_update.md | 18 +++-- docs/auth0_users_blocks_list.md | 14 ++-- docs/auth0_users_create.md | 20 ++--- docs/auth0_users_delete.md | 17 ++-- docs/auth0_users_import.md | 21 ++--- docs/auth0_users_open.md | 15 ++-- docs/auth0_users_search.md | 19 ++--- docs/auth0_users_show.md | 17 ++-- docs/auth0_users_unblock.md | 13 ++-- docs/auth0_users_update.md | 19 ++--- docs/index.md | 34 +++++++- internal/cli/actions.go | 53 +++++++------ internal/cli/api.go | 38 +++++---- internal/cli/apis.go | 53 +++++++------ internal/cli/apps.go | 54 +++++++------ ..._protection_breached_password_detection.go | 9 ++- ...ttack_protection_brute_force_protection.go | 10 ++- ...ack_protection_suspicious_ip_throttling.go | 8 +- internal/cli/completion.go | 59 +++++++------- internal/cli/custom_domains.go | 31 ++++---- internal/cli/doc-gen.go | 37 +++++++-- internal/cli/email_templates.go | 17 ++-- internal/cli/log_streams.go | 35 +++++---- internal/cli/organizations.go | 48 +++++++----- internal/cli/roles.go | 37 +++++---- internal/cli/roles_permissions.go | 19 +++-- internal/cli/rules.go | 44 ++++++----- internal/cli/test.go | 18 +++-- internal/cli/universal_login.go | 23 +++--- internal/cli/users.go | 55 ++++++------- 116 files changed, 1425 insertions(+), 1073 deletions(-) diff --git a/README.md b/README.md index 6482aa7b8..961a29561 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ -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 index 4d9a55924..34dfe4689 100644 --- 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 index 9452fcb37..38e5c2306 100644 --- 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 + auth0 actions delete --force +``` + ## Flags @@ -30,14 +40,6 @@ auth0 actions delete [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 actions delete - auth0 actions delete - auth0 actions delete --force -``` - ## Related Commands diff --git a/docs/auth0_actions_deploy.md b/docs/auth0_actions_deploy.md index cdae5f96a..9da3684be 100644 --- 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 + auth0 actions deploy --json +``` + ## Flags @@ -28,14 +37,6 @@ auth0 actions deploy [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 actions deploy - auth0 actions deploy - auth0 actions deploy --json -``` - ## Related Commands diff --git a/docs/auth0_actions_list.md b/docs/auth0_actions_list.md index b2ffc5572..005a37cb6 100644 --- 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 index 05785ff89..2fff02143 100644 --- 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 +``` + @@ -21,13 +29,6 @@ auth0 actions open [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 actions open - auth0 actions open -``` - ## Related Commands diff --git a/docs/auth0_actions_show.md b/docs/auth0_actions_show.md index 5bc98b065..5919f4b7a 100644 --- 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 + auth0 actions show --json +``` + ## Flags @@ -26,14 +35,6 @@ auth0 actions show [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 actions show - auth0 actions show - auth0 actions show --json -``` - ## Related Commands diff --git a/docs/auth0_actions_update.md b/docs/auth0_actions_update.md index d91c24753..08d92ea77 100644 --- a/docs/auth0_actions_update.md +++ b/docs/auth0_actions_update.md @@ -9,10 +9,24 @@ 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 + auth0 actions update --name myaction + auth0 actions update --name myaction --trigger post-login + auth0 actions update --name myaction --trigger post-login --code "$(cat path/to/code.js)" + auth0 actions update --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" + auth0 actions update --name myaction --trigger post-login --code "$(cat path/to/code.js)" --dependency "lodash=4.0.0" --secret "SECRET=value" + auth0 actions update --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 -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 update [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 actions update - auth0 actions update --name myaction - auth0 actions update -n myaction --trigger post-login - auth0 actions update -n myaction -t post-login -d "lodash=4.0.0" -d "uuid=9.0.0" - auth0 actions update -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 index 1ab0861ef..5e66a0c6e 100644 --- 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 [flags] +``` -Available Methods: - get, post, put, patch, delete +## Examples ``` -auth0 api [flags] + auth0 api get "tenants/settings" + auth0 api "stats/daily" -q "from=20221101" -q "to=20221118" + auth0 api delete "actions/actions/" --force + auth0 api clients --data "{\"name\":\"ssoTest\",\"app_type\":\"sso_integration\"}" + cat data.json | auth0 api post clients ``` @@ -38,13 +43,4 @@ auth0 api [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 index 8065b6dad..3ad8f7818 100644 --- 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 diff --git a/docs/auth0_apis_delete.md b/docs/auth0_apis_delete.md index dac9d4c16..c14eee99f 100644 --- a/docs/auth0_apis_delete.md +++ b/docs/auth0_apis_delete.md @@ -9,10 +9,20 @@ To delete interactively, use `auth0 apis delete` with no arguments. To delete non-interactively, supply the API id and the `--force` flag to skip confirmation. +## Usage ``` auth0 apis delete [flags] ``` +## Examples + +``` + auth0 apis delete + auth0 apis rm + auth0 apis delete + auth0 apis delete --force +``` + ## Flags @@ -30,14 +40,6 @@ auth0 apis delete [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apis delete - auth0 apis delete - auth0 apis delete --force -``` - ## Related Commands diff --git a/docs/auth0_apis_list.md b/docs/auth0_apis_list.md index eb1c88aec..98a739fa6 100644 --- a/docs/auth0_apis_list.md +++ b/docs/auth0_apis_list.md @@ -5,10 +5,20 @@ layout: default List your existing APIs. To create one, run: `auth0 apis create`. +## Usage ``` auth0 apis list [flags] ``` +## Examples + +``` + auth0 apis list + auth0 apis ls + auth0 apis ls --number 100 + auth0 apis ls -n 100 --json +``` + ## Flags @@ -27,15 +37,6 @@ auth0 apis list [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apis list - auth0 apis ls - auth0 actions ls --json - auth0 apis ls -n 100 -``` - ## Related Commands diff --git a/docs/auth0_apis_open.md b/docs/auth0_apis_open.md index a057bafcd..cc9bd5c27 100644 --- a/docs/auth0_apis_open.md +++ b/docs/auth0_apis_open.md @@ -5,10 +5,18 @@ layout: default Open an APIs' settings page in the Auth0 Dashboard. +## Usage ``` auth0 apis open [flags] ``` +## Examples + +``` + auth0 apis open + auth0 apis open +``` + @@ -21,13 +29,6 @@ auth0 apis open [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apis open - auth0 apis open -``` - ## Related Commands diff --git a/docs/auth0_apis_scopes_list.md b/docs/auth0_apis_scopes_list.md index 4656a22f1..27fbeebdf 100644 --- a/docs/auth0_apis_scopes_list.md +++ b/docs/auth0_apis_scopes_list.md @@ -5,10 +5,19 @@ layout: default List the scopes of an API. To update scopes, run: `auth0 apis update -s `. +## Usage ``` auth0 apis scopes list [flags] ``` +## Examples + +``` + auth0 apis scopes list + auth0 apis scopes ls + auth0 apis scopes ls --json +``` + ## Flags @@ -26,14 +35,6 @@ auth0 apis scopes list [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apis scopes list - auth0 apis scopes ls - auth0 apis scopes ls --json -``` - ## Related Commands diff --git a/docs/auth0_apis_show.md b/docs/auth0_apis_show.md index cd4141aef..94fea33dd 100644 --- a/docs/auth0_apis_show.md +++ b/docs/auth0_apis_show.md @@ -5,10 +5,19 @@ layout: default Display the name, scopes, token lifetime, and other information about an API. +## Usage ``` auth0 apis show [flags] ``` +## Examples + +``` + auth0 apis show + auth0 apis show + auth0 apis show --json +``` + ## Flags @@ -26,14 +35,6 @@ auth0 apis show [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apis show - auth0 apis show - auth0 apis show --json -``` - ## Related Commands diff --git a/docs/auth0_apis_update.md b/docs/auth0_apis_update.md index f8f881478..993566e29 100644 --- a/docs/auth0_apis_update.md +++ b/docs/auth0_apis_update.md @@ -9,10 +9,23 @@ To update interactively, use `auth0 apis update` with no arguments. To update non-interactively, supply the name, identifier, scopes, token lifetime and whether to allow offline access through the flags. +## Usage ``` auth0 apis update [flags] ``` +## Examples + +``` + auth0 apis update + auth0 apis update + auth0 apis update --name myapi + auth0 apis update --name myapi --token-lifetime 6100 + auth0 apis update --name myapi --token-lifetime 6100 --offline-access false + auth0 apis update --name myapi --token-lifetime 6100 --offline-access false --scopes "letter:write,letter:read" + auth0 apis update -n myapi -t 6100 -o false -s "letter:write,letter:read" --json +``` + ## Flags @@ -34,16 +47,6 @@ auth0 apis update [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apis update - auth0 apis update - auth0 apis update --name myapi - auth0 apis update -n myapi --token-expiration 6100 - auth0 apis update -n myapi -e 6100 --offline-access=true -``` - ## Related Commands diff --git a/docs/auth0_apps_create.md b/docs/auth0_apps_create.md index 2299054ab..18ff59d47 100644 --- a/docs/auth0_apps_create.md +++ b/docs/auth0_apps_create.md @@ -9,10 +9,22 @@ To create interactively, use `auth0 apps create` with no arguments. To create non-interactively, supply at least the application name, and type through the flags. +## Usage ``` auth0 apps create [flags] ``` +## Examples + +``` + auth0 apps create + auth0 apps create --name myapp + auth0 apps create --name myapp --description + auth0 apps create --name myapp --description --type [native|spa|regular|m2m] + auth0 apps create --name myapp --description --type [native|spa|regular|m2m] --reveal + auth0 apps create -n myapp -d -t [native|spa|regular|m2m] -r --json +``` + ## Flags @@ -44,16 +56,6 @@ auth0 apps create [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps create - auth0 apps create --name myapp - auth0 apps create --name myapp --json - auth0 apps create -n myapp --type [native|spa|regular|m2m] - auth0 apps create -n myapp -t [native|spa|regular|m2m] --description -``` - ## Related Commands diff --git a/docs/auth0_apps_delete.md b/docs/auth0_apps_delete.md index 816e8a296..244961ed1 100644 --- a/docs/auth0_apps_delete.md +++ b/docs/auth0_apps_delete.md @@ -9,10 +9,20 @@ To delete interactively, use `auth0 apps delete` with no arguments. To delete non-interactively, supply the application id and the `--force` flag to skip confirmation. +## Usage ``` auth0 apps delete [flags] ``` +## Examples + +``` + auth0 apps delete + auth0 apps rm + auth0 apps delete + auth0 apps delete --force +``` + ## Flags @@ -30,13 +40,6 @@ auth0 apps delete [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps delete - auth0 apps delete -``` - ## Related Commands diff --git a/docs/auth0_apps_list.md b/docs/auth0_apps_list.md index 30e03744f..c1bf9ca62 100644 --- a/docs/auth0_apps_list.md +++ b/docs/auth0_apps_list.md @@ -5,10 +5,21 @@ layout: default List your existing applications. To create one, run: `auth0 apps create`. +## Usage ``` auth0 apps list [flags] ``` +## Examples + +``` + auth0 apps list + auth0 apps ls + auth0 apps list --reveal + auth0 apps list --reveal --number 100 + auth0 apps ls -r -n 100 --json +``` + ## Flags @@ -28,15 +39,6 @@ auth0 apps list [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps list - auth0 apps ls - auth0 apps ls --json - auth0 apps ls -n 100 -``` - ## Related Commands diff --git a/docs/auth0_apps_open.md b/docs/auth0_apps_open.md index edc4a8770..e65066e2f 100644 --- a/docs/auth0_apps_open.md +++ b/docs/auth0_apps_open.md @@ -5,10 +5,18 @@ layout: default Open an application's settings page in the Auth0 Dashboard. +## Usage ``` auth0 apps open [flags] ``` +## Examples + +``` + auth0 apps open + auth0 apps open +``` + @@ -21,13 +29,6 @@ auth0 apps open [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps open - auth0 apps open -``` - ## Related Commands diff --git a/docs/auth0_apps_show.md b/docs/auth0_apps_show.md index b71ef9148..a31ad9eb8 100644 --- a/docs/auth0_apps_show.md +++ b/docs/auth0_apps_show.md @@ -5,10 +5,20 @@ layout: default Display the name, description, app type, and other information about an application. +## Usage ``` auth0 apps show [flags] ``` +## Examples + +``` + auth0 apps show + auth0 apps show + auth0 apps show --reveal + auth0 apps show --reveal --json +``` + ## Flags @@ -27,14 +37,6 @@ auth0 apps show [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps show - auth0 apps show --json - auth0 apps show -``` - ## Related Commands diff --git a/docs/auth0_apps_update.md b/docs/auth0_apps_update.md index 6a35229b4..7cd1b396b 100644 --- a/docs/auth0_apps_update.md +++ b/docs/auth0_apps_update.md @@ -9,10 +9,22 @@ To update interactively, use `auth0 apps update` with no arguments. To update non-interactively, supply the application id, name, type and other information you might want to change through the available flags. +## Usage ``` auth0 apps update [flags] ``` +## Examples + +``` + auth0 apps update + auth0 apps update --name myapp + auth0 apps update --name myapp --description + auth0 apps update --name myapp --description --type [native|spa|regular|m2m] + auth0 apps update --name myapp --description --type [native|spa|regular|m2m] --reveal + auth0 apps update -n myapp -d -t [native|spa|regular|m2m] -r --json +``` + ## Flags @@ -44,15 +56,6 @@ auth0 apps update [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps update - auth0 apps update --json - auth0 apps update --name myapp - auth0 apps update -n myapp --type [native|spa|regular|m2m] -``` - ## Related Commands diff --git a/docs/auth0_apps_use.md b/docs/auth0_apps_use.md index 620d41ef3..ad6d28b88 100644 --- a/docs/auth0_apps_use.md +++ b/docs/auth0_apps_use.md @@ -5,10 +5,19 @@ layout: default Specify the default application used when running other commands. Specifically when downloading quickstarts and testing Universal login flow. +## Usage ``` auth0 apps use [flags] ``` +## Examples + +``` + auth0 apps use + auth0 apps use --none + auth0 apps use +``` + ## Flags @@ -26,14 +35,6 @@ auth0 apps use [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 apps use - auth0 apps use --none - auth0 apps use -``` - ## Related Commands diff --git a/docs/auth0_completion.md b/docs/auth0_completion.md index 15630c084..a7585513d 100644 --- a/docs/auth0_completion.md +++ b/docs/auth0_completion.md @@ -3,50 +3,83 @@ layout: default --- # auth0 completion -completion [bash|zsh|fish|powershell] +## Loading completions -To load completions: +### Bash -Bash: +To load completion for the current session, run: +``` $ source <(auth0 completion bash) +``` -# To load completions for each session, execute once: -Linux: - $ auth0 completion bash > /etc/bash_completion.d/auth0 -MacOS: - $ auth0 completion bash > /usr/local/etc/bash_completion.d/auth0 +To load completions for each session, run once: -Zsh: +``` +# On Linux: +$ auth0 completion bash > /etc/bash_completion.d/auth0 + +# On MacOS: +$ auth0 completion bash > /usr/local/etc/bash_completion.d/auth0 +``` -# If shell completion is not already enabled in your environment you will need -# to enable it. You can execute the following once: +### Zsh: +If shell completion is not already enabled in your environment you will need to enable it. + +You can run the following once: + +``` $ echo "autoload -U compinit; compinit" >> ~/.zshrc +``` -# To load completions for each session, execute once: +To load completions for each session, run once: + +``` $ auth0 completion zsh > "${fpath[1]}/_auth0" +``` -# You will need to start a new shell for this setup to take effect. +You will need to start a new shell for this setup to take effect. -Fish: +### Fish: +``` $ auth0 completion fish | source +``` + +To load completions for each session, run once: -# To load completions for each session, execute once: +``` $ auth0 completion fish > ~/.config/fish/completions/auth0.fish +``` -Powershell: +### Powershell: +``` PS> auth0 completion powershell | Out-String | Invoke-Expression +``` + +To load completions for every new session, run: -# To load completions for every new session, run: +``` PS> auth0 completion powershell > auth0.ps1 -# and source this file from your powershell profile. +``` +and source this file from your powershell profile. + +## Usage ``` -auth0 completion +auth0 completion [bash|zsh|fish|powershell] +``` + +## Examples + +``` + auth0 completion bash + auth0 completion zsh + auth0 completion fish + auth0 completion powershell ``` @@ -61,10 +94,4 @@ auth0 completion --tenant string Specific tenant to use. ``` -## Examples - -``` - -``` - diff --git a/docs/auth0_domains_create.md b/docs/auth0_domains_create.md index 2687b557c..c18d9cf13 100644 --- a/docs/auth0_domains_create.md +++ b/docs/auth0_domains_create.md @@ -9,10 +9,22 @@ To create interactively, use `auth0 domains create` with no arguments. To create non-interactively, supply the domain name, type, policy and other information through the flags. +## Usage ``` auth0 domains create [flags] ``` +## Examples + +``` + auth0 domains create + auth0 domains create --domain + auth0 domains create --domain --policy recommended + auth0 domains create --domain --policy recommended --type auth0 + auth0 domains create --domain --policy recommended --type auth0 --ip-header "cf-connecting-ip" + auth0 domains create -d -p recommended -t auth0 -i "cf-connecting-ip" --json +``` + ## Flags @@ -35,14 +47,6 @@ auth0 domains create [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 domains create - auth0 domains create --domain - auth0 domains create --domain --json -``` - ## Related Commands diff --git a/docs/auth0_domains_delete.md b/docs/auth0_domains_delete.md index c02254287..bc4c012cc 100644 --- a/docs/auth0_domains_delete.md +++ b/docs/auth0_domains_delete.md @@ -9,10 +9,20 @@ To delete interactively, use `auth0 domains delete` with no arguments. To delete non-interactively, supply the custom domain id and the `--force` flag to skip confirmation. +## Usage ``` auth0 domains delete [flags] ``` +## Examples + +``` + auth0 domains delete + auth0 domains rm + auth0 domains delete + auth0 domains delete --force +``` + ## Flags @@ -30,14 +40,6 @@ auth0 domains delete [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 domains delete - auth0 domains delete - auth0 domains delete --force -``` - ## Related Commands diff --git a/docs/auth0_domains_list.md b/docs/auth0_domains_list.md index f4baaf8b6..33cd48f04 100644 --- a/docs/auth0_domains_list.md +++ b/docs/auth0_domains_list.md @@ -5,10 +5,19 @@ layout: default List your existing custom domains. To create one, run: `auth0 domains create`. +## Usage ``` auth0 domains list [flags] ``` +## Examples + +``` + auth0 domains list + auth0 domains ls + auth0 domains ls --json +``` + ## Flags @@ -26,14 +35,6 @@ auth0 domains list [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 domains list - auth0 domains ls - auth0 domains ls --json -``` - ## Related Commands diff --git a/docs/auth0_domains_show.md b/docs/auth0_domains_show.md index 2f44e960f..5d15a0089 100644 --- a/docs/auth0_domains_show.md +++ b/docs/auth0_domains_show.md @@ -5,10 +5,19 @@ layout: default Display information about a custom domain. +## Usage ``` auth0 domains show [flags] ``` +## Examples + +``` + auth0 domains show + auth0 domains show + auth0 domains show --json +``` + ## Flags @@ -26,14 +35,6 @@ auth0 domains show [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 domains show - auth0 domains show - auth0 domains show --json -``` - ## Related Commands diff --git a/docs/auth0_domains_update.md b/docs/auth0_domains_update.md index c92fc6777..db2bdbf41 100644 --- a/docs/auth0_domains_update.md +++ b/docs/auth0_domains_update.md @@ -9,10 +9,20 @@ To update interactively, use `auth0 domains update` with no arguments. To update non-interactively, supply the domain name, type, policy and other information through the flags. +## Usage ``` auth0 domains update [flags] ``` +## Examples + +``` + auth0 domains update + auth0 domains update --policy compatible + auth0 domains update --policy compatible --ip-header "cf-connecting-ip" + auth0 domains update -p compatible -i "cf-connecting-ip" --json +``` + ## Flags @@ -32,14 +42,6 @@ auth0 domains update [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 domains update - auth0 domains update --policy compatible - auth0 domains update -p compatible --ip-header "cf-connecting-ip" -``` - ## Related Commands diff --git a/docs/auth0_domains_verify.md b/docs/auth0_domains_verify.md index 9d8541dad..3d910ac40 100644 --- a/docs/auth0_domains_verify.md +++ b/docs/auth0_domains_verify.md @@ -9,10 +9,18 @@ To verify interactively, use `auth0 domains verify` with no arguments. To verify non-interactively, supply the custom domain id. +## Usage ``` auth0 domains verify [flags] ``` +## Examples + +``` + auth0 domains verify + auth0 domains verify +``` + ## Flags @@ -30,13 +38,6 @@ auth0 domains verify [flags] --tenant string Specific tenant to use. ``` -## Examples - -``` - auth0 domains verify - auth0 domains verify -``` - ## Related Commands diff --git a/docs/auth0_email_templates_show.md b/docs/auth0_email_templates_show.md index b6ceba22a..df604ccfb 100644 --- a/docs/auth0_email_templates_show.md +++ b/docs/auth0_email_templates_show.md @@ -5,10 +5,19 @@ layout: default Display information about an email template. +## Usage ``` auth0 email templates show [flags] ``` +## Examples + +``` + auth0 email templates show + auth0 email templates show