From e73805521e433673dd09edaf463d2bea4366450f Mon Sep 17 00:00:00 2001 From: Sergiu Ghitea <28300158+sergiught@users.noreply.github.com> Date: Thu, 22 Dec 2022 18:43:15 +0100 Subject: [PATCH 1/3] Fix second level related commands and regenerate docs (#573) --- docs/auth0_actions.md | 40 +++-------- docs/auth0_actions_create.md | 49 +++++++------ docs/auth0_actions_delete.md | 40 +++++++---- docs/auth0_actions_deploy.md | 40 ++++++----- docs/auth0_actions_list.md | 41 ++++++----- docs/auth0_actions_open.md | 38 ++++++----- docs/auth0_actions_show.md | 40 ++++++----- docs/auth0_actions_update.md | 49 +++++++------ docs/auth0_api.md | 30 ++++---- docs/auth0_apis.md | 40 +++-------- docs/auth0_apis_create.md | 45 +++++++----- docs/auth0_apis_delete.md | 40 +++++++---- docs/auth0_apis_list.md | 43 ++++++------ docs/auth0_apis_open.md | 39 +++++------ docs/auth0_apis_scopes.md | 28 ++------ docs/auth0_apis_scopes_list.md | 34 +++++----- docs/auth0_apis_show.md | 40 ++++++----- docs/auth0_apis_update.md | 45 +++++++----- docs/auth0_apps.md | 40 +++-------- docs/auth0_apps_create.md | 44 +++++++----- docs/auth0_apps_delete.md | 39 +++++++---- docs/auth0_apps_list.md | 43 ++++++------ docs/auth0_apps_open.md | 38 ++++++----- docs/auth0_apps_show.md | 40 ++++++----- docs/auth0_apps_update.md | 42 +++++++----- docs/auth0_apps_use.md | 39 ++++++----- docs/auth0_completion.md | 20 +++--- docs/auth0_domains.md | 38 +++-------- docs/auth0_domains_create.md | 39 +++++++---- docs/auth0_domains_delete.md | 39 +++++++---- docs/auth0_domains_list.md | 40 ++++++----- docs/auth0_domains_show.md | 39 ++++++----- docs/auth0_domains_update.md | 40 ++++++----- docs/auth0_domains_verify.md | 38 +++++++---- docs/auth0_email.md | 28 ++------ docs/auth0_email_templates.md | 28 ++------ docs/auth0_email_templates_show.md | 34 +++++----- docs/auth0_email_templates_update.md | 35 ++++++---- docs/auth0_ips.md | 30 ++------ docs/auth0_ips_check.md | 33 ++++----- docs/auth0_ips_unblock.md | 33 ++++----- docs/auth0_login.md | 30 ++++---- docs/auth0_logout.md | 25 +++---- docs/auth0_logs.md | 30 ++------ docs/auth0_logs_list.md | 47 ++++++------- docs/auth0_logs_streams.md | 38 +++-------- docs/auth0_logs_streams_create.md | 48 ++++++++----- docs/auth0_logs_streams_delete.md | 39 +++++++---- docs/auth0_logs_streams_list.md | 40 ++++++----- docs/auth0_logs_streams_open.md | 37 +++++----- docs/auth0_logs_streams_show.md | 39 ++++++----- docs/auth0_logs_streams_update.md | 49 +++++++------ docs/auth0_logs_tail.md | 45 ++++++------ docs/auth0_orgs.md | 42 +++--------- docs/auth0_orgs_create.md | 46 ++++++++----- docs/auth0_orgs_delete.md | 40 +++++++---- docs/auth0_orgs_list.md | 44 ++++++------ docs/auth0_orgs_members.md | 26 +------ docs/auth0_orgs_members_list.md | 34 +++++----- docs/auth0_orgs_open.md | 39 ++++++----- docs/auth0_orgs_roles.md | 30 ++------ docs/auth0_orgs_roles_list.md | 33 ++++----- docs/auth0_orgs_roles_members.md | 28 ++------ docs/auth0_orgs_roles_members_list.md | 31 ++++----- docs/auth0_orgs_show.md | 41 ++++++----- docs/auth0_orgs_update.md | 44 +++++++----- docs/auth0_protection.md | 32 ++------- ..._protection_breached-password-detection.md | 30 ++------ ...ection_breached-password-detection_show.md | 33 ++++----- ...tion_breached-password-detection_update.md | 33 ++++----- ...auth0_protection_brute-force-protection.md | 30 ++------ ..._protection_brute-force-protection_show.md | 33 ++++----- ...rotection_brute-force-protection_update.md | 33 ++++----- ...th0_protection_suspicious-ip-throttling.md | 30 ++------ ...rotection_suspicious-ip-throttling_show.md | 33 ++++----- ...tection_suspicious-ip-throttling_update.md | 33 ++++----- docs/auth0_quickstarts.md | 28 ++------ docs/auth0_quickstarts_download.md | 34 +++++----- docs/auth0_quickstarts_list.md | 37 +++++----- docs/auth0_roles.md | 38 +++-------- docs/auth0_roles_create.md | 40 ++++++----- docs/auth0_roles_delete.md | 39 +++++++---- docs/auth0_roles_list.md | 42 ++++++------ docs/auth0_roles_permissions.md | 30 ++------ docs/auth0_roles_permissions_add.md | 38 +++++------ docs/auth0_roles_permissions_list.md | 37 +++++----- docs/auth0_roles_permissions_remove.md | 38 +++++------ docs/auth0_roles_show.md | 39 ++++++----- docs/auth0_roles_update.md | 40 ++++++----- docs/auth0_rules.md | 40 +++-------- docs/auth0_rules_create.md | 43 +++++++----- docs/auth0_rules_delete.md | 40 +++++++---- docs/auth0_rules_disable.md | 36 ++++++---- docs/auth0_rules_enable.md | 36 ++++++---- docs/auth0_rules_list.md | 41 ++++++----- docs/auth0_rules_show.md | 40 ++++++----- docs/auth0_rules_update.md | 41 ++++++----- docs/auth0_tenants.md | 30 ++------ docs/auth0_tenants_list.md | 31 ++++----- docs/auth0_tenants_open.md | 34 +++++----- docs/auth0_tenants_use.md | 34 +++++----- docs/auth0_test.md | 28 ++------ docs/auth0_test_login.md | 34 +++++----- docs/auth0_test_token.md | 32 ++++----- docs/auth0_universal-login.md | 32 ++------- docs/auth0_universal-login_prompts.md | 28 ++------ docs/auth0_universal-login_prompts_show.md | 33 +++++---- docs/auth0_universal-login_prompts_update.md | 33 +++++---- docs/auth0_universal-login_show.md | 33 +++++---- docs/auth0_universal-login_templates.md | 28 ++------ docs/auth0_universal-login_templates_show.md | 33 ++++----- .../auth0_universal-login_templates_update.md | 30 ++++---- docs/auth0_universal-login_update.md | 38 ++++++----- docs/auth0_users.md | 44 ++++-------- docs/auth0_users_blocks.md | 26 +------ docs/auth0_users_blocks_list.md | 29 ++++---- docs/auth0_users_create.md | 45 +++++++----- docs/auth0_users_delete.md | 41 +++++++---- docs/auth0_users_import.md | 45 ++++++------ docs/auth0_users_open.md | 41 +++++------ docs/auth0_users_search.md | 46 +++++++------ docs/auth0_users_show.md | 42 +++++++----- docs/auth0_users_unblock.md | 37 +++++----- docs/auth0_users_update.md | 45 +++++++----- docs/index.md | 68 +++++++++++-------- internal/cli/doc-gen.go | 9 ++- 126 files changed, 2242 insertions(+), 2409 deletions(-) diff --git a/docs/auth0_actions.md b/docs/auth0_actions.md index 0635a3ab7..79454bce5 100644 --- 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 index dbadd7c38..4d9a55924 100644 --- 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 index 775cd57d8..9452fcb37 100644 --- 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 -``` -### 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 --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 actions delete + auth0 actions delete + auth0 actions delete --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 index c406097da..cdae5f96a 100644 --- 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 -``` -### 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 --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 actions deploy + auth0 actions deploy + auth0 actions deploy --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 index 7e272c8bc..b2ffc5572 100644 --- 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 index d857d955a..05785ff89 100644 --- 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 -``` -### Options - -``` - -h, --help help for open -``` -### Options inherited from parent commands +## InheritedFlags ``` --debug Enable debug mode. @@ -34,7 +21,22 @@ auth0 actions open --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 actions open + auth0 actions open +``` + + +## 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_show.md b/docs/auth0_actions_show.md index 55bcc2bd9..5bc98b065 100644 --- a/docs/auth0_actions_show.md +++ b/docs/auth0_actions_show.md @@ -1,33 +1,23 @@ --- layout: default --- -## auth0 actions show +# auth0 actions show -Show an action - -### Synopsis - -Show an action. +Display the name, type, status, code and other information about an action. ``` auth0 actions show [flags] ``` -### Examples - -``` -auth0 actions show -auth0 actions show -``` -### Options +## Flags ``` - -h, --help help for show --json Output in json format. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +26,23 @@ auth0 actions show --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 actions show + auth0 actions show + auth0 actions show --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_update.md b/docs/auth0_actions_update.md index eecd6d0f4..d91c24753 100644 --- a/docs/auth0_actions_update.md +++ b/docs/auth0_actions_update.md @@ -1,41 +1,32 @@ --- layout: default --- -## auth0 actions update +# auth0 actions update -Update an action +Update an action. -### Synopsis +To update interactively, use `auth0 actions update` with no arguments. -Update an action. +To update non-interactively, supply the action id, name, trigger, secrets and dependencies through the flags. ``` auth0 actions update [flags] ``` -### 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=8.0.0" -auth0 actions update -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 update + -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 update -n myaction -t post-login -d "lodash=4.0.0" -s "API_KE --tenant string Specific tenant to use. ``` -### SEE ALSO +## 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 + +- [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_api.md b/docs/auth0_api.md index c5ba5da7e..1ab0861ef 100644 --- a/docs/auth0_api.md +++ b/docs/auth0_api.md @@ -1,11 +1,7 @@ --- layout: default --- -## auth0 api - -Makes an authenticated HTTP request to the Auth0 Management API - -### Synopsis +# auth0 api Makes an authenticated HTTP request to the Auth0 Management API and returns the response as JSON. @@ -23,25 +19,17 @@ Available Methods: auth0 api [flags] ``` -### 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 -``` -### Options +## Flags ``` -d, --data string JSON data payload to send with the request. Data can be piped in as well instead of using this flag. --force Skip confirmation when using the delete method. - -h, --help help for api -q, --query stringToString Query params to send with the request. (default []) ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -50,7 +38,13 @@ cat data.json | auth0 api post clients --tenant string Specific tenant to use. ``` -### SEE ALSO +## 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 +``` -* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. diff --git a/docs/auth0_apis.md b/docs/auth0_apis.md index 1559cff39..b2556a393 100644 --- a/docs/auth0_apis.md +++ b/docs/auth0_apis.md @@ -1,37 +1,17 @@ --- layout: default --- -## auth0 apis +# auth0 apis -Manage resources for APIs +Manage resources for APIs. An API is an entity that represents an external resource, capable of accepting and responding to protected resource requests made by applications. In the OAuth2 specification, an API maps to the Resource Server. -### Synopsis +## Commands -Manage resources for APIs. - -### Options - -``` - -h, --help help for apis -``` - -### 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 apis create](auth0_apis_create.md) - Create a new API -* [auth0 apis delete](auth0_apis_delete.md) - Delete an API -* [auth0 apis list](auth0_apis_list.md) - List your APIs -* [auth0 apis open](auth0_apis_open.md) - Open API settings page in the Auth0 Dashboard -* [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes -* [auth0 apis show](auth0_apis_show.md) - Show an API -* [auth0 apis update](auth0_apis_update.md) - Update an API +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API diff --git a/docs/auth0_apis_create.md b/docs/auth0_apis_create.md index 8373d7bc3..8065b6dad 100644 --- a/docs/auth0_apis_create.md +++ b/docs/auth0_apis_create.md @@ -1,32 +1,22 @@ --- layout: default --- -## auth0 apis create +# auth0 apis create -Create a new API +Create a new API. -### Synopsis +To create interactively, use `auth0 apis create` with no flags. -Create a new API. +To create non-interactively, supply the name, identifier, scopes, token lifetime and whether to allow offline access through the flags. ``` auth0 apis create [flags] ``` -### 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 -``` -### Options +## Flags ``` - -h, --help help for create -i, --identifier string Identifier of the API. Cannot be changed once set. --json Output in json format. -n, --name string Name of the API. @@ -35,7 +25,8 @@ auth0 apis create -n myapi -e 6100 --offline-access=true -l, --token-lifetime int The amount of time in seconds that the token will be valid after being issued. Default value is 86400 seconds (1 day). ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -44,7 +35,25 @@ auth0 apis create -n myapi -e 6100 --offline-access=true --tenant string Specific tenant to use. ``` -### SEE ALSO +## 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 + +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API -* [auth0 apis](auth0_apis.md) - Manage resources for APIs diff --git a/docs/auth0_apis_delete.md b/docs/auth0_apis_delete.md index 607b11c05..dac9d4c16 100644 --- a/docs/auth0_apis_delete.md +++ b/docs/auth0_apis_delete.md @@ -1,33 +1,27 @@ --- layout: default --- -## auth0 apis delete +# auth0 apis delete -Delete an API +Delete an API. -### Synopsis +To delete interactively, use `auth0 apis delete` with no arguments. -Delete an API. +To delete non-interactively, supply the API id and the `--force` flag to skip confirmation. ``` auth0 apis delete [flags] ``` -### Examples - -``` -auth0 apis delete -auth0 apis delete -``` -### 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 apis delete --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apis delete + auth0 apis delete + auth0 apis delete --force +``` + + +## Related Commands + +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API -* [auth0 apis](auth0_apis.md) - Manage resources for APIs diff --git a/docs/auth0_apis_list.md b/docs/auth0_apis_list.md index 002fca904..eb1c88aec 100644 --- a/docs/auth0_apis_list.md +++ b/docs/auth0_apis_list.md @@ -1,36 +1,24 @@ --- layout: default --- -## auth0 apis list +# auth0 apis list -List your APIs - -### Synopsis - -List your existing APIs. To create one try: -auth0 apis create +List your existing APIs. To create one, run: `auth0 apis create`. ``` auth0 apis list [flags] ``` -### Examples - -``` -auth0 apis list -auth0 apis ls -auth0 apis ls -n 100 -``` -### Options +## Flags ``` - -h, --help help for list --json Output in json format. -n, --number int Number of apps to retrieve (default 50) ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -39,7 +27,24 @@ auth0 apis ls -n 100 --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apis list + auth0 apis ls + auth0 actions ls --json + auth0 apis ls -n 100 +``` + + +## Related Commands + +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API -* [auth0 apis](auth0_apis.md) - Manage resources for APIs diff --git a/docs/auth0_apis_open.md b/docs/auth0_apis_open.md index ff8f74d12..a057bafcd 100644 --- a/docs/auth0_apis_open.md +++ b/docs/auth0_apis_open.md @@ -1,32 +1,18 @@ --- layout: default --- -## auth0 apis open +# auth0 apis open -Open API settings page in the Auth0 Dashboard - -### Synopsis - -Open API settings page in the Auth0 Dashboard. +Open an APIs' settings page in the Auth0 Dashboard. ``` auth0 apis open [flags] ``` -### Examples -``` -auth0 apis open -auth0 apis open -``` -### Options - -``` - -h, --help help for open -``` -### Options inherited from parent commands +## InheritedFlags ``` --debug Enable debug mode. @@ -35,7 +21,22 @@ auth0 apis open --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apis open + auth0 apis open +``` + + +## Related Commands + +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API -* [auth0 apis](auth0_apis.md) - Manage resources for APIs diff --git a/docs/auth0_apis_scopes.md b/docs/auth0_apis_scopes.md index 49e9e9a6e..86385eec1 100644 --- a/docs/auth0_apis_scopes.md +++ b/docs/auth0_apis_scopes.md @@ -1,31 +1,11 @@ --- layout: default --- -## auth0 apis scopes +# auth0 apis scopes -Manage resources for API scopes +API Scopes define the specific actions applications can be allowed to do on a user's behalf. -### Synopsis +## Commands -Manage resources for API scopes. - -### Options - -``` - -h, --help help for scopes -``` - -### 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 apis](auth0_apis.md) - Manage resources for APIs -* [auth0 apis scopes list](auth0_apis_scopes_list.md) - List the scopes of an API +- [auth0 apis scopes list](auth0_apis_scopes_list.md) - List the scopes of an API diff --git a/docs/auth0_apis_scopes_list.md b/docs/auth0_apis_scopes_list.md index dc2441a81..4656a22f1 100644 --- a/docs/auth0_apis_scopes_list.md +++ b/docs/auth0_apis_scopes_list.md @@ -1,33 +1,23 @@ --- layout: default --- -## auth0 apis scopes list +# auth0 apis scopes list -List the scopes of an API - -### Synopsis - -List the scopes of an API. +List the scopes of an API. To update scopes, run: `auth0 apis update -s `. ``` auth0 apis scopes list [flags] ``` -### Examples - -``` -auth0 apis scopes list -auth0 apis scopes ls -``` -### Options +## Flags ``` - -h, --help help for list --json Output in json format. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +26,17 @@ auth0 apis scopes ls --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apis scopes list + auth0 apis scopes ls + auth0 apis scopes ls --json +``` + + +## Related Commands + +- [auth0 apis scopes list](auth0_apis_scopes_list.md) - List the scopes of an API -* [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes diff --git a/docs/auth0_apis_show.md b/docs/auth0_apis_show.md index 021e9951b..cd4141aef 100644 --- a/docs/auth0_apis_show.md +++ b/docs/auth0_apis_show.md @@ -1,33 +1,23 @@ --- layout: default --- -## auth0 apis show +# auth0 apis show -Show an API - -### Synopsis - -Show an API. +Display the name, scopes, token lifetime, and other information about an API. ``` auth0 apis show [flags] ``` -### Examples - -``` -auth0 apis show -auth0 apis show -``` -### Options +## Flags ``` - -h, --help help for show --json Output in json format. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +26,23 @@ auth0 apis show --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apis show + auth0 apis show + auth0 apis show --json +``` + + +## Related Commands + +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API -* [auth0 apis](auth0_apis.md) - Manage resources for APIs diff --git a/docs/auth0_apis_update.md b/docs/auth0_apis_update.md index d2e44c9ce..f8f881478 100644 --- a/docs/auth0_apis_update.md +++ b/docs/auth0_apis_update.md @@ -1,32 +1,22 @@ --- layout: default --- -## auth0 apis update +# auth0 apis update -Update an API +Update an API. -### Synopsis +To update interactively, use `auth0 apis update` with no arguments. -Update an API. +To update non-interactively, supply the name, identifier, scopes, token lifetime and whether to allow offline access through the flags. ``` auth0 apis update [flags] ``` -### 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 -``` -### Options +## Flags ``` - -h, --help help for update --json Output in json format. -n, --name string Name of the API. -o, --offline-access Whether Refresh Tokens can be issued for this API (true) or not (false). @@ -34,7 +24,8 @@ auth0 apis update -n myapi -e 6100 --offline-access=true -l, --token-lifetime int The amount of time in seconds that the token will be valid after being issued. Default value is 86400 seconds (1 day). ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -43,7 +34,25 @@ auth0 apis update -n myapi -e 6100 --offline-access=true --tenant string Specific tenant to use. ``` -### SEE ALSO +## 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 + +- [auth0 apis create](auth0_apis_create.md) - Create a new API +- [auth0 apis delete](auth0_apis_delete.md) - Delete an API +- [auth0 apis list](auth0_apis_list.md) - List your APIs +- [auth0 apis open](auth0_apis_open.md) - Open the settings page of an API +- [auth0 apis scopes](auth0_apis_scopes.md) - Manage resources for API scopes +- [auth0 apis show](auth0_apis_show.md) - Show an API +- [auth0 apis update](auth0_apis_update.md) - Update an API -* [auth0 apis](auth0_apis.md) - Manage resources for APIs diff --git a/docs/auth0_apps.md b/docs/auth0_apps.md index fe9c3771e..21b3296ea 100644 --- a/docs/auth0_apps.md +++ b/docs/auth0_apps.md @@ -1,37 +1,17 @@ --- layout: default --- -## auth0 apps +# auth0 apps -Manage resources for applications +The term application or app in Auth0 does not imply any particular implementation characteristics. For example, it could be a native app that executes on a mobile device, a single-page application that executes on a browser, or a regular web application that executes on a server. -### Synopsis +## Commands -Manage resources for applications. - -### Options - -``` - -h, --help help for apps -``` - -### 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 apps create](auth0_apps_create.md) - Create a new application -* [auth0 apps delete](auth0_apps_delete.md) - Delete an application -* [auth0 apps list](auth0_apps_list.md) - List your applications -* [auth0 apps open](auth0_apps_open.md) - Open application settings page in the Auth0 Dashboard -* [auth0 apps show](auth0_apps_show.md) - Show an application -* [auth0 apps update](auth0_apps_update.md) - Update an application -* [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI diff --git a/docs/auth0_apps_create.md b/docs/auth0_apps_create.md index cf8b73b2b..2299054ab 100644 --- a/docs/auth0_apps_create.md +++ b/docs/auth0_apps_create.md @@ -1,35 +1,26 @@ --- layout: default --- -## auth0 apps create +# auth0 apps create -Create a new application +Create a new application. -### Synopsis +To create interactively, use `auth0 apps create` with no arguments. -Create a new application. +To create non-interactively, supply at least the application name, and type through the flags. ``` auth0 apps create [flags] ``` -### Examples - -``` -auth0 apps create -auth0 apps create --name myapp -auth0 apps create -n myapp --type [native|spa|regular|m2m] -auth0 apps create -n myapp -t [native|spa|regular|m2m] --description -``` -### Options +## Flags ``` -a, --auth-method string Defines the requested authentication method for the token endpoint. Possible values are 'None' (public application without a client secret), 'Post' (application uses HTTP POST parameters) or 'Basic' (application uses HTTP Basic). -c, --callbacks strings After the user authenticates we will only call back to any of these URLs. You can specify multiple valid URLs by comma-separating them (typically to handle different environments like QA or testing). Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native apps, all callbacks should use protocol https://. -d, --description string Description of the application. Max character count is 140. -g, --grants strings List of grant types supported for this application. Can include code, implicit, refresh-token, credentials, password, password-realm, mfa-oob, mfa-otp, mfa-recovery-code, and device-code. - -h, --help help for create --json Output in json format. -l, --logout-urls strings Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. -n, --name string Name of the application. @@ -43,7 +34,8 @@ auth0 apps create -n myapp -t [native|spa|regular|m2m] --description +``` + + +## Related Commands + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_apps_delete.md b/docs/auth0_apps_delete.md index b2c57a1b3..816e8a296 100644 --- a/docs/auth0_apps_delete.md +++ b/docs/auth0_apps_delete.md @@ -1,33 +1,27 @@ --- layout: default --- -## auth0 apps delete +# auth0 apps delete -Delete an application +Delete an application. -### Synopsis +To delete interactively, use `auth0 apps delete` with no arguments. -Delete an application. +To delete non-interactively, supply the application id and the `--force` flag to skip confirmation. ``` auth0 apps delete [flags] ``` -### Examples - -``` -auth0 apps delete -auth0 apps delete -``` -### Options +## Flags ``` --force Skip confirmation. - -h, --help help for delete ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +30,22 @@ auth0 apps delete --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apps delete + auth0 apps delete +``` + + +## Related Commands + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_apps_list.md b/docs/auth0_apps_list.md index d5f403935..30e03744f 100644 --- a/docs/auth0_apps_list.md +++ b/docs/auth0_apps_list.md @@ -1,37 +1,25 @@ --- layout: default --- -## auth0 apps list +# auth0 apps list -List your applications - -### Synopsis - -List your existing applications. To create one try: -auth0 apps create +List your existing applications. To create one, run: `auth0 apps create`. ``` auth0 apps list [flags] ``` -### Examples - -``` -auth0 apps list -auth0 apps ls -auth0 apps ls -n 100 -``` -### Options +## Flags ``` - -h, --help help for list --json Output in json format. -n, --number int Number of apps to retrieve (default 50) -r, --reveal Display the Client Secret as part of the command output. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -40,7 +28,24 @@ auth0 apps ls -n 100 --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apps list + auth0 apps ls + auth0 apps ls --json + auth0 apps ls -n 100 +``` + + +## Related Commands + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_apps_open.md b/docs/auth0_apps_open.md index a20249793..edc4a8770 100644 --- a/docs/auth0_apps_open.md +++ b/docs/auth0_apps_open.md @@ -1,31 +1,18 @@ --- layout: default --- -## auth0 apps open +# auth0 apps open -Open application settings page in the Auth0 Dashboard - -### Synopsis - -Open application settings page in the Auth0 Dashboard. +Open an application's settings page in the Auth0 Dashboard. ``` auth0 apps open [flags] ``` -### Examples -``` -auth0 apps open -``` -### Options - -``` - -h, --help help for open -``` -### Options inherited from parent commands +## InheritedFlags ``` --debug Enable debug mode. @@ -34,7 +21,22 @@ auth0 apps open --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apps open + auth0 apps open +``` + + +## Related Commands + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_apps_show.md b/docs/auth0_apps_show.md index 8d7ab3401..b71ef9148 100644 --- a/docs/auth0_apps_show.md +++ b/docs/auth0_apps_show.md @@ -1,34 +1,24 @@ --- layout: default --- -## auth0 apps show +# auth0 apps show -Show an application - -### Synopsis - -Show an application. +Display the name, description, app type, and other information about an application. ``` auth0 apps show [flags] ``` -### Examples - -``` -auth0 apps show -auth0 apps show -``` -### Options +## Flags ``` - -h, --help help for show --json Output in json format. -r, --reveal Display the Client Secret as part of the command output. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -37,7 +27,23 @@ auth0 apps show --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apps show + auth0 apps show --json + auth0 apps show +``` + + +## Related Commands + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_apps_update.md b/docs/auth0_apps_update.md index d11e1dfbb..6a35229b4 100644 --- a/docs/auth0_apps_update.md +++ b/docs/auth0_apps_update.md @@ -1,34 +1,26 @@ --- layout: default --- -## auth0 apps update +# auth0 apps update -Update an application +Update an application. -### Synopsis +To update interactively, use `auth0 apps update` with no arguments. -Update an application. +To update non-interactively, supply the application id, name, type and other information you might want to change through the available flags. ``` auth0 apps update [flags] ``` -### Examples - -``` -auth0 apps update -auth0 apps update --name myapp -auth0 apps update -n myapp --type [native|spa|regular|m2m] -``` -### Options +## Flags ``` -a, --auth-method string Defines the requested authentication method for the token endpoint. Possible values are 'None' (public application without a client secret), 'Post' (application uses HTTP POST parameters) or 'Basic' (application uses HTTP Basic). -c, --callbacks strings After the user authenticates we will only call back to any of these URLs. You can specify multiple valid URLs by comma-separating them (typically to handle different environments like QA or testing). Make sure to specify the protocol (https://) otherwise the callback may fail in some cases. With the exception of custom URI schemes for native apps, all callbacks should use protocol https://. -d, --description string Description of the application. Max character count is 140. -g, --grants strings List of grant types supported for this application. Can include code, implicit, refresh-token, credentials, password, password-realm, mfa-oob, mfa-otp, mfa-recovery-code, and device-code. - -h, --help help for update --json Output in json format. -l, --logout-urls strings Comma-separated list of URLs that are valid to redirect to after logout from Auth0. Wildcards are allowed for subdomains. -n, --name string Name of the application. @@ -42,7 +34,8 @@ auth0 apps update -n myapp --type [native|spa|regular|m2m] -w, --web-origins strings Comma-separated list of allowed origins for use with Cross-Origin Authentication, Device Flow, and web message response mode. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -51,7 +44,24 @@ auth0 apps update -n myapp --type [native|spa|regular|m2m] --tenant string Specific tenant to use. ``` -### SEE ALSO +## 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 + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_apps_use.md b/docs/auth0_apps_use.md index d5e89b31e..620d41ef3 100644 --- a/docs/auth0_apps_use.md +++ b/docs/auth0_apps_use.md @@ -1,32 +1,23 @@ --- layout: default --- -## auth0 apps use +# auth0 apps use -Choose a default application for the Auth0 CLI - -### Synopsis - -Specify your preferred application for interaction with the Auth0 CLI. +Specify the default application used when running other commands. Specifically when downloading quickstarts and testing Universal login flow. ``` auth0 apps use [flags] ``` -### Examples - -``` -auth0 apps use -``` -### Options +## Flags ``` - -h, --help help for use -n, --none Specify none of your apps. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -35,7 +26,23 @@ auth0 apps use --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 apps use + auth0 apps use --none + auth0 apps use +``` + + +## Related Commands + +- [auth0 apps create](auth0_apps_create.md) - Create a new application +- [auth0 apps delete](auth0_apps_delete.md) - Delete an application +- [auth0 apps list](auth0_apps_list.md) - List your applications +- [auth0 apps open](auth0_apps_open.md) - Open the settings page of an application +- [auth0 apps show](auth0_apps_show.md) - Show an application +- [auth0 apps update](auth0_apps_update.md) - Update an application +- [auth0 apps use](auth0_apps_use.md) - Choose a default application for the Auth0 CLI -* [auth0 apps](auth0_apps.md) - Manage resources for applications diff --git a/docs/auth0_completion.md b/docs/auth0_completion.md index 39753dd78..15630c084 100644 --- a/docs/auth0_completion.md +++ b/docs/auth0_completion.md @@ -1,11 +1,7 @@ --- layout: default --- -## auth0 completion - -Setup autocomplete features for this CLI on your terminal - -### Synopsis +# auth0 completion completion [bash|zsh|fish|powershell] @@ -53,13 +49,10 @@ PS> auth0 completion powershell > auth0.ps1 auth0 completion ``` -### Options -``` - -h, --help help for completion -``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -68,7 +61,10 @@ auth0 completion --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + +``` -* [auth0](/auth0-cli/) - Build, manage and test your Auth0 integrations from the command line. diff --git a/docs/auth0_domains.md b/docs/auth0_domains.md index 4630e987d..9df385b9c 100644 --- a/docs/auth0_domains.md +++ b/docs/auth0_domains.md @@ -1,36 +1,16 @@ --- layout: default --- -## auth0 domains +# auth0 domains -Manage custom domains +With a custom domain, your users feel confident that they are providing their credentials to the right party. Authentication happens within the context of your brand which helps you build brand loyalty. Users are not redirected to a third-party site that breaks the branding context. This prevents users from becoming confused about whether they are still making a transaction or operation with you. -### Synopsis +## Commands -Manage custom domains. - -### Options - -``` - -h, --help help for domains -``` - -### 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 domains create](auth0_domains_create.md) - Create a custom domain -* [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain -* [auth0 domains list](auth0_domains_list.md) - List your custom domains -* [auth0 domains show](auth0_domains_show.md) - Show a custom domain -* [auth0 domains update](auth0_domains_update.md) - Update a custom domain -* [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain diff --git a/docs/auth0_domains_create.md b/docs/auth0_domains_create.md index cff022a6c..2687b557c 100644 --- a/docs/auth0_domains_create.md +++ b/docs/auth0_domains_create.md @@ -1,30 +1,23 @@ --- layout: default --- -## auth0 domains create +# auth0 domains create -Create a custom domain +Create a custom domain. -### Synopsis +To create interactively, use `auth0 domains create` with no arguments. -Create a custom domain. +To create non-interactively, supply the domain name, type, policy and other information through the flags. ``` auth0 domains create [flags] ``` -### Examples - -``` -auth0 domains create -auth0 domains create -``` -### Options +## Flags ``` -d, --domain string Domain name. - -h, --help help for create -i, --ip-header string The HTTP header to fetch the client's IP address. --json Output in json format. -p, --policy string The TLS version policy. Can be either 'compatible' or 'recommended'. @@ -32,7 +25,8 @@ auth0 domains create -v, --verification string Custom domain verification method. Must be 'txt'. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -41,7 +35,22 @@ auth0 domains create --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 domains create + auth0 domains create --domain + auth0 domains create --domain --json +``` + + +## Related Commands + +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain -* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_domains_delete.md b/docs/auth0_domains_delete.md index 8f22d860f..c02254287 100644 --- a/docs/auth0_domains_delete.md +++ b/docs/auth0_domains_delete.md @@ -1,33 +1,27 @@ --- layout: default --- -## auth0 domains delete +# auth0 domains delete -Delete a custom domain +Delete a custom domain. -### Synopsis +To delete interactively, use `auth0 domains delete` with no arguments. -Delete a custom domain. +To delete non-interactively, supply the custom domain id and the `--force` flag to skip confirmation. ``` auth0 domains delete [flags] ``` -### Examples - -``` -auth0 domains delete -auth0 domains delete -``` -### Options +## Flags ``` --force Skip confirmation. - -h, --help help for delete ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +30,22 @@ auth0 domains delete --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 domains delete + auth0 domains delete + auth0 domains delete --force +``` + + +## Related Commands + +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain -* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_domains_list.md b/docs/auth0_domains_list.md index bc8580dc4..f4baaf8b6 100644 --- a/docs/auth0_domains_list.md +++ b/docs/auth0_domains_list.md @@ -1,34 +1,23 @@ --- layout: default --- -## auth0 domains list +# auth0 domains list -List your custom domains - -### Synopsis - -List your existing custom domains. To create one try: -auth0 domains create +List your existing custom domains. To create one, run: `auth0 domains create`. ``` auth0 domains list [flags] ``` -### Examples - -``` -auth0 domains list -auth0 domains 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,22 @@ auth0 domains ls --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 domains list + auth0 domains ls + auth0 domains ls --json +``` + + +## Related Commands + +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain -* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_domains_show.md b/docs/auth0_domains_show.md index a363fd6be..2f44e960f 100644 --- a/docs/auth0_domains_show.md +++ b/docs/auth0_domains_show.md @@ -1,33 +1,23 @@ --- layout: default --- -## auth0 domains show +# auth0 domains show -Show a custom domain - -### Synopsis - -Show a custom domain. +Display information about a custom domain. ``` auth0 domains show [flags] ``` -### Examples - -``` -auth0 domains show -auth0 domains show -``` -### Options +## Flags ``` - -h, --help help for show --json Output in json format. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +26,22 @@ auth0 domains show --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 domains show + auth0 domains show + auth0 domains show --json +``` + + +## Related Commands + +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain -* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_domains_update.md b/docs/auth0_domains_update.md index 40a72f105..c92fc6777 100644 --- a/docs/auth0_domains_update.md +++ b/docs/auth0_domains_update.md @@ -1,36 +1,29 @@ --- layout: default --- -## auth0 domains update +# auth0 domains update -Update a custom domain +Update a custom domain. -### Synopsis +To update interactively, use `auth0 domains update` with no arguments. -Update a custom domain. +To update non-interactively, supply the domain name, type, policy and other information through the flags. ``` auth0 domains update [flags] ``` -### Examples - -``` -auth0 domains update -auth0 domains update --policy compatible -auth0 domains update -p compatible --ip-header "cf-connecting-ip" -``` -### Options +## Flags ``` - -h, --help help for update -i, --ip-header string The HTTP header to fetch the client's IP address. --json Output in json format. -p, --policy string The TLS version policy. Can be either 'compatible' or 'recommended'. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -39,7 +32,22 @@ auth0 domains update -p compatible --ip-header "cf-connecting-ip" --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 domains update + auth0 domains update --policy compatible + auth0 domains update -p compatible --ip-header "cf-connecting-ip" +``` + + +## Related Commands + +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain -* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_domains_verify.md b/docs/auth0_domains_verify.md index db435a3b1..9d8541dad 100644 --- a/docs/auth0_domains_verify.md +++ b/docs/auth0_domains_verify.md @@ -1,33 +1,27 @@ --- layout: default --- -## auth0 domains verify +# auth0 domains verify -Verify a custom domain +Verify a custom domain. -### Synopsis +To verify interactively, use `auth0 domains verify` with no arguments. -Verify a custom domain. +To verify non-interactively, supply the custom domain id. ``` auth0 domains verify [flags] ``` -### Examples - -``` -auth0 domains verify -auth0 domains verify -``` -### Options +## Flags ``` - -h, --help help for verify --json Output in json format. ``` -### Options inherited from parent commands + +## InheritedFlags ``` --debug Enable debug mode. @@ -36,7 +30,21 @@ auth0 domains verify --tenant string Specific tenant to use. ``` -### SEE ALSO +## Examples + +``` + auth0 domains verify + auth0 domains verify +``` + + +## Related Commands + +- [auth0 domains create](auth0_domains_create.md) - Create a custom domain +- [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +- [auth0 domains list](auth0_domains_list.md) - List your custom domains +- [auth0 domains show](auth0_domains_show.md) - Show a custom domain +- [auth0 domains update](auth0_domains_update.md) - Update a custom domain +- [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain -* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_email.md b/docs/auth0_email.md index f8dbfbaea..6489ca906 100644 --- a/docs/auth0_email.md +++ b/docs/auth0_email.md @@ -1,31 +1,11 @@ --- layout: default --- -## auth0 email +# auth0 email -Manage email settings +You can configure a test SMTP email server in your development or test environments to check for successful email delivery and view how emails you send appear to recipients prior to going to production. -### Synopsis +## Commands -Manage email settings. - -### Options - -``` - -h, --help help for email -``` - -### 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 email templates](auth0_email_templates.md) - Manage custom email templates +- [auth0 email templates](auth0_email_templates.md) - Manage custom email templates diff --git a/docs/auth0_email_templates.md b/docs/auth0_email_templates.md index 08384f266..8395ae494 100644 --- a/docs/auth0_email_templates.md +++ b/docs/auth0_email_templates.md @@ -1,32 +1,12 @@ --- layout: default --- -## auth0 email templates - -Manage custom email templates - -### Synopsis +# auth0 email templates Manage custom email templates. This requires a custom email provider to be configured for the tenant. -### Options - -``` - -h, --help help for templates -``` - -### 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 +## Commands -* [auth0 email](auth0_email.md) - Manage email settings -* [auth0 email templates show](auth0_email_templates_show.md) - Show an email template -* [auth0 email templates update](auth0_email_templates_update.md) - Update an email template +- [auth0 email templates show](auth0_email_templates_show.md) - Show an email template +- [auth0 email templates update](auth0_email_templates_update.md) - Update an email template diff --git a/docs/auth0_email_templates_show.md b/docs/auth0_email_templates_show.md index 975212cb5..b6ceba22a 100644 --- a/docs/auth0_email_templates_show.md +++ b/docs/auth0_email_templates_show.md @@ -1,33 +1,23 @@ --- layout: default --- -## auth0 email templates show +# auth0 email templates show -Show an email template - -### Synopsis - -Show an email template. +Display information about an email template. ``` auth0 email templates show [flags] ``` -### Examples - -``` -auth0 email templates show