From 718bf7bf14d03bf3b7f83d5c8485022fd40e79da Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:00:43 -0500 Subject: [PATCH 1/8] Updating README --- README.md | 243 +++++++++++++++--------------------------------------- 1 file changed, 65 insertions(+), 178 deletions(-) diff --git a/README.md b/README.md index cb9ebdbd9..e853d9b51 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,36 @@ -# Auth0 CLI (Experimental) +
+

Auth0 CLI

-`auth0` is the command line to supercharge your development workflow. +[![Release](https://img.shields.io/github/v/release/auth0/auth0-cli?include_prereleases&style=flat-square)](https://github.com/auth0/auth0-cli/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/auth0/auth0-cli/go.yml?branch=v1)](https://github.com/auth0/auth0-cli/actions?query=branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/auth0/auth0-cli?style=flat-square)](https://goreportcard.com/report/github.com/auth0/auth0-cli) [![License](https://img.shields.io/github/license/auth0/auth0-cli.svg?style=flat-square)](https://github.com/auth0/auth0-cli/blob/main/LICENSE) -> Note: This CLI is an experimental release, and is built on a best-efforts basis by some Auth0 developers in their available innovation time. It is open-source licensed and free to use, and is not covered by any Auth0 Terms of Service or Agreements. If you have issues with this CLI you can engage with the project's developer community through the repository GitHub Issues list, or contribute fixes and enhancements of your own via a Pull Request. +
-Build, test, troubleshoot and manage your integration with **[Auth0](http://auth0.com/)** directly from your **terminal**. +# Auth0 CLI + +Build, manage and test your [Auth0](http://auth0.com/) integrations from the command line. ![demo](./demo.gif) --- +## Highlights + +- **πŸ§ͺ Test your universal login flow:** Emulate your end users' login experience by running `auth0 test login`. +- **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command +- **πŸ” Simplify repetitive tasks:** Create, update, list and delete your Auth0 resources directly from the terminal. + +--- + ## Table of Contents -- [Features](#features) - [Installation](#installation) -- [Usage](#usage) +- [Authentication](#authentication) +- [Available Commands](#available-commands) - [Customization](#customization) - [Anonymous Analytics](#anonymous-analytics) -- [Contributing](#contributing) -- [Author](#author) --- -## Features - -### πŸ§ͺ Test the login flow at any time - -You can easily test out the Universal Login box of your Auth0 application by running `auth0 test login`. This initiates a login flow in your browser. Once you complete the process, the Auth0 CLI will display your profile information and credentials. - -### ⚑️ Get up and running quickly - -You can also download a QuickStart sample application that’s already configured for your Auth0 application with `auth0 quickstarts download`. Just install the dependencies, and the sample application will be ready to run. Use it as an example integration to help set up Auth0 in your own application. - -### πŸ” Find issues faster - -If you encounter difficulties setting up your integration, use the Auth0 CLI to tail your tenant’s logs for a smoother troubleshooting experience. `auth0 logs tail` will let you inspect the authentication events as they happen. You can easily filter the events from a single Auth0 application with `--filter "client_id:"` and use `--debug` to get the raw error details. - -### πŸ” Simplify repetitive tasks - -With the Auth0 CLI, you can: - -- Manage your Auth0 applications, rules, and APIs right from the terminal. -- Create, update, and delete resources interactively. -- List all your resources or inspect them individually. - ## Installation ### macOS @@ -94,7 +81,7 @@ go install github.com/auth0/auth0-cli/cmd/auth0@latest ## Authentication -Authenticating to your tenant is required for most functions of the CLI. It can be initiated by running: +Authenticating to your Auth0 tenant is required for most functions of the CLI. It can be initiated by running: ```bash auth0 login @@ -108,167 +95,67 @@ There are two ways to authenticate: > **Warning** > Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials. -## Usage - -After installation, you should have the `auth0` command available: - -```bash -auth0 [command] - -# For any help, run --help after a specific command, e.g.: -auth0 [command] --help -``` - -- [auth0 actions](https://auth0.github.io/auth0-cli/auth0_actions.html) - Manage resources for actions -- [auth0 apis](https://auth0.github.io/auth0-cli/auth0_apis.html) - Manage resources for APIs -- [auth0 apps](https://auth0.github.io/auth0-cli/auth0_apps.html) - Manage resources for applications -- [auth0 attack-protection](https://auth0.github.io/auth0-cli/auth0_attack_protection.html) - Manage attack protection settings -- [auth0 branding](https://auth0.github.io/auth0-cli/auth0_branding.html) - Manage branding options -- [auth0 completion](https://auth0.github.io/auth0-cli/auth0_completion.html) - Setup autocomplete features for this CLI on your terminal -- [auth0 ips](https://auth0.github.io/auth0-cli/auth0_ips.html) - Manage blocked IP addresses -- [auth0 login](https://auth0.github.io/auth0-cli/auth0_login.html) - Authenticate the Auth0 CLI -- [auth0 logout](https://auth0.github.io/auth0-cli/auth0_logout.html) - Log out of a tenant's session -- [auth0 logs](https://auth0.github.io/auth0-cli/auth0_logs.html) - View tenant logs -- [auth0 orgs](https://auth0.github.io/auth0-cli/auth0_orgs.html) - Manage resources for organizations -- [auth0 quickstarts](https://auth0.github.io/auth0-cli/auth0_quickstarts.html) - Quickstart support for getting bootstrapped -- [auth0 roles](https://auth0.github.io/auth0-cli/auth0_roles.html) - Manage resources for roles -- [auth0 rules](https://auth0.github.io/auth0-cli/auth0_rules.html) - Manage resources for rules -- [auth0 tenants](https://auth0.github.io/auth0-cli/auth0_tenants.html) - Manage configured tenants -- [auth0 test](https://auth0.github.io/auth0-cli/auth0_test.html) - Try your Universal Login box or get a token -- [auth0 users](https://auth0.github.io/auth0-cli/auth0_users.html) - Manage resources for users - -### Creating an application - -If you haven't created an application yet, you may do so by running the -following command: - -```bash -auth0 apps create -``` - -A screen similar to the following will be presented after successful app creation: - -```bash -$ auth0 apps create - Name: My Awesome App - Description: Test app - Type: Regular Web Application - Callback URLs: http://localhost:3000 - Allowed Logout URLs: http://localhost:3000 - -=== travel0.auth0.com application created - - CLIENT ID wmVzrZkGhKgglMRMvpauORCulBkQ5qeI - NAME My Awesome App - DESCRIPTION Test app - TYPE regular web application - CLIENT SECRET kaS2NR5nk2PcGuITQ8JoKnpVnc5ky1TuKgsb6iTA08ec8XqizqkDupKhEIcsFiNM - CALLBACKS http://localhost:3000 - ALLOWED LOGOUT URLS http://localhost:3000 - ALLOWED ORIGINS - ALLOWED WEB ORIGINS - TOKEN ENDPOINT AUTH - GRANTS implicit, authorization_code, refresh_token, client_credentials - - β–Έ Quickstarts: https://auth0.com/docs/quickstart/webapp - β–Έ Hint: Test this app's login box with 'auth0 test login wmVzrZkGhKgglMRMvpauORCulBkQ5qeI' - β–Έ Hint: You might wanna try 'auth0 quickstarts download wmVzrZkGhKgglMRMvpauORCulBkQ5qeI' -``` - -As you might observe, the next thing to do would likely be to try logging in -using the client ID. - -### Test the login flow - -Whether or not you've created the application using the CLI or the management -dashboard, you'll be able to test logging in using a specific application. - -If you have the client ID, you may pass it as an argument, -otherwise a prompt will be presented: - -```bash -auth0 test login -``` - -### Tail your logs - -Once you have a few logins in place, you might want to tail your logs. This is -done by running the following command: - -```bash -auth0 logs tail -``` - -After running that, one might see the following output: +## Available Commands + +- [auth0 actions](auth0_actions.md) - Manage resources for actions +- [auth0 api](auth0_api.md) - Makes an authenticated HTTP request to the Auth0 Management API +- [auth0 apis](auth0_apis.md) - Manage resources for APIs +- [auth0 apps](auth0_apps.md) - Manage resources for applications +- [auth0 completion](auth0_completion.md) - Setup autocomplete features for this CLI on your terminal +- [auth0 domains](auth0_domains.md) - Manage custom domains +- [auth0 email](auth0_email.md) - Manage email settings +- [auth0 ips](auth0_ips.md) - Manage blocked IP addresses +- [auth0 login](auth0_login.md) - Authenticate the Auth0 CLI +- [auth0 logout](auth0_logout.md) - Log out of a tenant's session +- [auth0 logs](auth0_logs.md) - View tenant logs +- [auth0 orgs](auth0_orgs.md) - Manage resources for organizations +- [auth0 protection](auth0_protection.md) - Manage resources for attack protection +- [auth0 quickstarts](auth0_quickstarts.md) - Quickstart support for getting bootstrapped +- [auth0 roles](auth0_roles.md) - Manage resources for roles +- [auth0 rules](auth0_rules.md) - Manage resources for rules +- [auth0 tenants](auth0_tenants.md) - Manage configured tenants +- [auth0 test](auth0_test.md) - Try your Universal Login box or get a token +- [auth0 universal-login](auth0_universal-login.md) - Manage the Universal Login experience +- [auth0 users](auth0_users.md) - Manage resources for users -``` -Success Login 9 minutes ago Username-Password-Authentic... my awesome app -``` - -If there are errors encountered, such as the following example, you may run it -with the `--debug` flag as follows: - -```bash -auth0 logs tail --debug -``` +## Customization -The full raw data will be displayed below every error: +To change the text editor used for editing templates, rules, and actions, +set the environment variable `EDITOR` to your preferred editor. Example: -``` -Failed Login hello 7 minutes ago N/A my awesome app - - id: "90020210306002808976000921438552554184272624146777636962" - logid: "90020210306002808976000921438552554184272624146777636962" - date: 2021-03-06T00:28:04.91Z - type: f - clientid: vXAtoaFdhlmtWjpIrjb9AUnrGEAOH2MM - clientname: my awesome app - ip: 1.2.3.4 - description: hello - locationinfo: {} - details: - body: - action: default - password: '*****' - state: QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK - username: j.doe@gmail.com - connection: Username-Password-Authentication - error: - message: hello - oauthError: access_denied - type: oauth-authorization - qs: {} - session_id: QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK - userid: auth0|QXV0aDAgaXMgaGlyaW5nISBhdXRoMC5jb20vY2FyZWVycyAK +```shell +export EDITOR="code -w" +# or +export EDITOR="nano" ``` -## Customization +## Anonymized Analytics Disclosure -To change the text editor used for editing templates, rules, and actions, -set the environment variable `EDITOR` to your preferred editor: +Anonymized data points are collected during the use of this CLI. This data includes the CLI version, operating system, timestamp, and other technical details that do not personally identify you. -`export EDITOR="code -w"` +Auth0 uses this data to better understand the usage of this tool to prioritize the features, enhancements and fixes that matter most to our users. -`export EDITOR="nano"` +To **opt-out** of this collection, set the `AUTH0_CLI_ANALYTICS` environment variable to `false`. -## Anonymous Analytics +## Issue Reporting -By default, the CLI tracks some anonymous usage events. This helps us understand how the CLI is being used, so we can continue to improve it. You can opt-out by setting the environment variable `AUTH0_CLI_ANALYTICS` to `false`. +For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/tag/deploy-cli) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-deploy-cli/issues) if you have found a bug or want to request a feature. -### Data sent +**Do not report security vulnerabilities on the public GitHub issue tracker.** The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. -Every event tracked sends the following data along with the event name: +## What is Auth0? -- The CLI version. -- The OS name: as determined by the value of `GOOS`, e.g. `windows`. -- The processor architecture: as determined by the value of `GOARCH`, e.g. `amd64`. -- The install ID: an anonymous UUID that is stored in the CLI's config file. -- A timestamp. +Auth0 helps you to: -## Contributing +- Add authentication with [multiple sources](https://auth0.com/docs/authenticate/identity-providers), either social identity providers such as **Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce** (amongst others), or enterprise identity systems like **Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML identity provider**. +- Add authentication through more traditional **[username/password databases](https://auth0.com/docs/authenticate/database-connections/custom-db)**. +- Add support for **[linking different user accounts](https://auth0.com/docs/manage-users/user-accounts/user-account-linking)** with the same user. +- Support for generating signed [JSON Web Tokens](https://auth0.com/docs/secure/tokens/json-web-tokens) to call your APIs and **flow the user identity** securely. +- Analytics of how, when, and where users are logging in. +- Pull data from other sources and add it to the user profile through [JavaScript Actions](https://auth0.com/docs/customize/actions). -Please check the [contributing guidelines](CONTRIBUTING.md). +**Why Auth0?** Because you should save time, be happy, and focus on what really matters: building your product. -## Author +## License -[Auth0](https://auth0.com) +This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more information. From c4d4adeec383820f9aa38f6f47865c5736033fee Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:13:05 -0500 Subject: [PATCH 2/8] Targeting main branch before we forget to change back --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e853d9b51..727b1f087 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

Auth0 CLI

-[![Release](https://img.shields.io/github/v/release/auth0/auth0-cli?include_prereleases&style=flat-square)](https://github.com/auth0/auth0-cli/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/auth0/auth0-cli/go.yml?branch=v1)](https://github.com/auth0/auth0-cli/actions?query=branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/auth0/auth0-cli?style=flat-square)](https://goreportcard.com/report/github.com/auth0/auth0-cli) [![License](https://img.shields.io/github/license/auth0/auth0-cli.svg?style=flat-square)](https://github.com/auth0/auth0-cli/blob/main/LICENSE) +[![Release](https://img.shields.io/github/v/release/auth0/auth0-cli?include_prereleases&style=flat-square)](https://github.com/auth0/auth0-cli/releases) [![Build Status](https://img.shields.io/github/actions/workflow/status/auth0/auth0-cli/go.yml?branch=main)](https://github.com/auth0/auth0-cli/actions?query=branch%3Amain) [![Go Report Card](https://goreportcard.com/badge/github.com/auth0/auth0-cli?style=flat-square)](https://goreportcard.com/report/github.com/auth0/auth0-cli) [![License](https://img.shields.io/github/license/auth0/auth0-cli.svg?style=flat-square)](https://github.com/auth0/auth0-cli/blob/main/LICENSE)
@@ -56,7 +56,7 @@ Install via [cURL](https://curl.se/): ```bash # Binary will be downloaded to "./auth0". -curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/v1/install.sh | sh -s -- -b . +curl -sSfL https://raw.githubusercontent.com/auth0/auth0-cli/main/install.sh | sh -s -- -b . ``` ### Manual From ddcf1168ac5ee1f83a182439fb51876f78cb0280 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:17:02 -0500 Subject: [PATCH 3/8] Fixing link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 727b1f087..4c5a3b3f4 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ To **opt-out** of this collection, set the `AUTH0_CLI_ANALYTICS` environment var ## Issue Reporting -For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/tag/deploy-cli) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-deploy-cli/issues) if you have found a bug or want to request a feature. +For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-cli/issues) if you have found a bug or want to request a feature. **Do not report security vulnerabilities on the public GitHub issue tracker.** The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. From 48f27e34bfbb21d33f35f5d1c9b50fde0e2756b9 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:24:30 -0500 Subject: [PATCH 4/8] Removing redundant header, removing line breaks --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index 4c5a3b3f4..c67f4dc07 100644 --- a/README.md +++ b/README.md @@ -5,22 +5,16 @@ -# Auth0 CLI - Build, manage and test your [Auth0](http://auth0.com/) integrations from the command line. ![demo](./demo.gif) ---- - ## Highlights - **πŸ§ͺ Test your universal login flow:** Emulate your end users' login experience by running `auth0 test login`. - **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command - **πŸ” Simplify repetitive tasks:** Create, update, list and delete your Auth0 resources directly from the terminal. ---- - ## Table of Contents - [Installation](#installation) @@ -29,8 +23,6 @@ Build, manage and test your [Auth0](http://auth0.com/) integrations from the com - [Customization](#customization) - [Anonymous Analytics](#anonymous-analytics) ---- - ## Installation ### macOS From 4a001408c31b65008940fad50b332a425e076c93 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:25:33 -0500 Subject: [PATCH 5/8] Fixing documentation links --- README.md | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c67f4dc07..5c1759599 100644 --- a/README.md +++ b/README.md @@ -89,26 +89,26 @@ There are two ways to authenticate: ## Available Commands -- [auth0 actions](auth0_actions.md) - Manage resources for actions -- [auth0 api](auth0_api.md) - Makes an authenticated HTTP request to the Auth0 Management API -- [auth0 apis](auth0_apis.md) - Manage resources for APIs -- [auth0 apps](auth0_apps.md) - Manage resources for applications -- [auth0 completion](auth0_completion.md) - Setup autocomplete features for this CLI on your terminal -- [auth0 domains](auth0_domains.md) - Manage custom domains -- [auth0 email](auth0_email.md) - Manage email settings -- [auth0 ips](auth0_ips.md) - Manage blocked IP addresses -- [auth0 login](auth0_login.md) - Authenticate the Auth0 CLI -- [auth0 logout](auth0_logout.md) - Log out of a tenant's session -- [auth0 logs](auth0_logs.md) - View tenant logs -- [auth0 orgs](auth0_orgs.md) - Manage resources for organizations -- [auth0 protection](auth0_protection.md) - Manage resources for attack protection -- [auth0 quickstarts](auth0_quickstarts.md) - Quickstart support for getting bootstrapped -- [auth0 roles](auth0_roles.md) - Manage resources for roles -- [auth0 rules](auth0_rules.md) - Manage resources for rules -- [auth0 tenants](auth0_tenants.md) - Manage configured tenants -- [auth0 test](auth0_test.md) - Try your Universal Login box or get a token -- [auth0 universal-login](auth0_universal-login.md) - Manage the Universal Login experience -- [auth0 users](auth0_users.md) - Manage resources for users +- [auth0 actions](https://auth0.github.io/auth0-cli/auth0_actions.html) - Manage resources for actions +- [auth0 api](https://auth0.github.io/auth0-cli/auth0_api.html) - Makes an authenticated HTTP request to the Auth0 Management API +- [auth0 apis](https://auth0.github.io/auth0-cli/auth0_apis.html) - Manage resources for APIs +- [auth0 apps](https://auth0.github.io/auth0-cli/auth0_apps.html) - Manage resources for applications +- [auth0 completion](https://auth0.github.io/auth0-cli/auth0_completion.html) - Setup autocomplete features for this CLI on your terminal +- [auth0 domains](https://auth0.github.io/auth0-cli/auth0_domains.html) - Manage custom domains +- [auth0 email](https://auth0.github.io/auth0-cli/auth0_email.html) - Manage email settings +- [auth0 ips](https://auth0.github.io/auth0-cli/auth0_ips.html) - Manage blocked IP addresses +- [auth0 login](https://auth0.github.io/auth0-cli/auth0_login.html) - Authenticate the Auth0 CLI +- [auth0 logout](https://auth0.github.io/auth0-cli/auth0_logout.html) - Log out of a tenant's session +- [auth0 logs](https://auth0.github.io/auth0-cli/auth0_logs.html) - View tenant logs +- [auth0 orgs](https://auth0.github.io/auth0-cli/auth0_orgs.html) - Manage resources for organizations +- [auth0 protection](https://auth0.github.io/auth0-cli/auth0_protection.html) - Manage resources for attack protection +- [auth0 quickstarts](https://auth0.github.io/auth0-cli/auth0_quickstarts.html) - Quickstart support for getting bootstrapped +- [auth0 roles](https://auth0.github.io/auth0-cli/auth0_roles.html) - Manage resources for roles +- [auth0 rules](https://auth0.github.io/auth0-cli/auth0_rules.html) - Manage resources for rules +- [auth0 tenants](https://auth0.github.io/auth0-cli/auth0_tenants.html) - Manage configured tenants +- [auth0 test](https://auth0.github.io/auth0-cli/auth0_test.html) - Try your Universal Login box or get a token +- [auth0 universal-login](https://auth0.github.io/auth0-cli/auth0_universal-login.html) - Manage the Universal Login experience +- [auth0 users](https://auth0.github.io/auth0-cli/auth0_users.html) - Manage resources for users ## Customization From 54611177c2c0b7ca6e9e895aa4d80998a0e620db Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Mon, 19 Dec 2022 16:40:00 -0500 Subject: [PATCH 6/8] Adding period --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c1759599..a166e6ce3 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Build, manage and test your [Auth0](http://auth0.com/) integrations from the com ## Highlights - **πŸ§ͺ Test your universal login flow:** Emulate your end users' login experience by running `auth0 test login`. -- **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command +- **πŸ” Troubleshoot in real-time:** Inspect the events of your Auth0 integration as they happen with the `auth0 logs tail` command. - **πŸ” Simplify repetitive tasks:** Create, update, list and delete your Auth0 resources directly from the terminal. ## Table of Contents From dff86f0e1b3b3303b3e16d7fbac32d664f2e4800 Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Tue, 20 Dec 2022 07:38:30 -0500 Subject: [PATCH 7/8] More descriptive heading --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a166e6ce3..7df3a6e96 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Build, manage and test your [Auth0](http://auth0.com/) integrations from the com ## Table of Contents - [Installation](#installation) -- [Authentication](#authentication) +- [Authenticating to Your Tenant](#authenticating-to-your-tenant) - [Available Commands](#available-commands) - [Customization](#customization) - [Anonymous Analytics](#anonymous-analytics) @@ -71,7 +71,7 @@ Install via [Go](https://go.dev/): go install github.com/auth0/auth0-cli/cmd/auth0@latest ``` -## Authentication +## Authenticating to Your Tenant Authenticating to your Auth0 tenant is required for most functions of the CLI. It can be initiated by running: From cec2758327d6d39ff89397fecda048d5b43b9fda Mon Sep 17 00:00:00 2001 From: Will Vedder Date: Wed, 21 Dec 2022 10:16:14 -0500 Subject: [PATCH 8/8] Reworking feedback section --- README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7df3a6e96..6482aa7b8 100644 --- a/README.md +++ b/README.md @@ -129,25 +129,33 @@ Auth0 uses this data to better understand the usage of this tool to prioritize t To **opt-out** of this collection, set the `AUTH0_CLI_ANALYTICS` environment variable to `false`. -## Issue Reporting +## Feedback -For general support or usage questions, use the [Auth0 Community](https://community.auth0.com/) forums or raise a [support ticket](https://support.auth0.com/). Only [raise an issue](https://github.com/auth0/auth0-cli/issues) if you have found a bug or want to request a feature. +### Contributing -**Do not report security vulnerabilities on the public GitHub issue tracker.** The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. +We appreciate feedback and contribution to this repo! Before you get started, please see the following: -## What is Auth0? +- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md) +- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) +- [This repo's contribution guide](https://github.com/auth0/auth0-cli/blob/main/CONTRIBUTING.md) -Auth0 helps you to: +### Raise an issue -- Add authentication with [multiple sources](https://auth0.com/docs/authenticate/identity-providers), either social identity providers such as **Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce** (amongst others), or enterprise identity systems like **Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML identity provider**. -- Add authentication through more traditional **[username/password databases](https://auth0.com/docs/authenticate/database-connections/custom-db)**. -- Add support for **[linking different user accounts](https://auth0.com/docs/manage-users/user-accounts/user-account-linking)** with the same user. -- Support for generating signed [JSON Web Tokens](https://auth0.com/docs/secure/tokens/json-web-tokens) to call your APIs and **flow the user identity** securely. -- Analytics of how, when, and where users are logging in. -- Pull data from other sources and add it to the user profile through [JavaScript Actions](https://auth0.com/docs/customize/actions). +To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/auth0/auth0-cli/issues). -**Why Auth0?** Because you should save time, be happy, and focus on what really matters: building your product. +### Vulnerability Reporting -## License +Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. -This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more information. +--- + +

+ + + + Auth0 Logo + +

+

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

+

+This project is licensed under the MIT license. See the LICENSE file for more info.