From b6e2933f925d9341a467986d43475cc40bfbdfac Mon Sep 17 00:00:00 2001 From: Rita Zerrizuela Date: Wed, 14 Jul 2021 19:02:36 -0300 Subject: [PATCH] Update docs --- docs/auth0_branding_templates.md | 17 ++++++++- docs/auth0_roles.md | 1 + docs/auth0_roles_permissions.md | 35 +++++++++++++++++++ docs/auth0_roles_permissions_add.md | 48 ++++++++++++++++++++++++++ docs/auth0_roles_permissions_list.md | 44 +++++++++++++++++++++++ docs/auth0_roles_permissions_remove.md | 48 ++++++++++++++++++++++++++ docs/auth0_users_create.md | 2 +- docs/auth0_users_update.md | 2 +- internal/cli/users.go | 2 +- 9 files changed, 195 insertions(+), 4 deletions(-) create mode 100644 docs/auth0_roles_permissions.md create mode 100644 docs/auth0_roles_permissions_add.md create mode 100644 docs/auth0_roles_permissions_list.md create mode 100644 docs/auth0_roles_permissions_remove.md diff --git a/docs/auth0_branding_templates.md b/docs/auth0_branding_templates.md index 9054aa191..daee84a4d 100644 --- a/docs/auth0_branding_templates.md +++ b/docs/auth0_branding_templates.md @@ -7,7 +7,22 @@ Manage custom page templates ### Synopsis -Manage custom page templates. This requires at least one custom domain to be configured for the tenant. +Manage custom [page templates](https://auth0.com/docs/universal-login/new-experience/universal-login-page-templates). This requires a custom domain to be configured for the tenant. + +This command will open two windows: + +* A browser window with a [Storybook](https://storybook.js.org/) that shows the login page with the page template applied: + +![storybook](images/templates-storybook.png) + +* The default terminal editor, with the page template code: + +![storybook](images/templates-vs-code.png) + +You now change the page template code, and the changes will be reflected in the browser window. + +Once you close the window, you’ll be asked if you want to save the template. If you answer Yes, the template will be uploaded to your tenant. + ### Options diff --git a/docs/auth0_roles.md b/docs/auth0_roles.md index a42d48c64..4a84b6070 100644 --- a/docs/auth0_roles.md +++ b/docs/auth0_roles.md @@ -32,6 +32,7 @@ Manage resources for roles. * [auth0 roles create](auth0_roles_create.md) - Create a new role * [auth0 roles delete](auth0_roles_delete.md) - Delete a role * [auth0 roles list](auth0_roles_list.md) - List your roles +* [auth0 roles permissions](auth0_roles_permissions.md) - Manage permissions within the role resource * [auth0 roles show](auth0_roles_show.md) - Show a role * [auth0 roles update](auth0_roles_update.md) - Update a role diff --git a/docs/auth0_roles_permissions.md b/docs/auth0_roles_permissions.md new file mode 100644 index 000000000..0483d0cd1 --- /dev/null +++ b/docs/auth0_roles_permissions.md @@ -0,0 +1,35 @@ +--- +layout: default +--- +## auth0 roles permissions + +Manage permissions within the role resource + +### Synopsis + +Manage permissions within the role resource. + +### Options + +``` + -h, --help help for permissions +``` + +### Options inherited from parent commands + +``` + --debug Enable debug mode. + --force Skip confirmation. + --format string Command output format. Options: json. + --no-color Disable colors. + --no-input Disable interactivity. + --tenant string Specific tenant to use. +``` + +### SEE ALSO + +* [auth0 roles](auth0_roles.md) - Manage resources for roles +* [auth0 roles permissions add](auth0_roles_permissions_add.md) - Add a permission to a role +* [auth0 roles permissions list](auth0_roles_permissions_list.md) - List permissions defined within a role +* [auth0 roles permissions remove](auth0_roles_permissions_remove.md) - Remove a permission from a role + diff --git a/docs/auth0_roles_permissions_add.md b/docs/auth0_roles_permissions_add.md new file mode 100644 index 000000000..df766c5ad --- /dev/null +++ b/docs/auth0_roles_permissions_add.md @@ -0,0 +1,48 @@ +--- +layout: default +--- +## auth0 roles permissions add + +Add a permission to a role + +### Synopsis + +Add an existing permission defined in one of your APIs. +To add a permission try: + + auth0 roles permissions add -p + +``` +auth0 roles permissions add [flags] +``` + +### Examples + +``` +auth0 roles permissions add -p +auth0 roles permissions add +``` + +### Options + +``` + -a, --api-id string API Identifier. + -h, --help help for add + -p, --permissions strings Permissions. +``` + +### Options inherited from parent commands + +``` + --debug Enable debug mode. + --force Skip confirmation. + --format string Command output format. Options: json. + --no-color Disable colors. + --no-input Disable interactivity. + --tenant string Specific tenant to use. +``` + +### SEE ALSO + +* [auth0 roles permissions](auth0_roles_permissions.md) - Manage permissions within the role resource + diff --git a/docs/auth0_roles_permissions_list.md b/docs/auth0_roles_permissions_list.md new file mode 100644 index 000000000..18b92ff0e --- /dev/null +++ b/docs/auth0_roles_permissions_list.md @@ -0,0 +1,44 @@ +--- +layout: default +--- +## auth0 roles permissions list + +List permissions defined within a role + +### Synopsis + +List existing permissions defined in a role. To add a permission try: +auth0 roles permissions add + +``` +auth0 roles permissions list [flags] +``` + +### Examples + +``` +auth0 roles permissions list +auth0 roles permissions ls +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --debug Enable debug mode. + --force Skip confirmation. + --format string Command output format. Options: json. + --no-color Disable colors. + --no-input Disable interactivity. + --tenant string Specific tenant to use. +``` + +### SEE ALSO + +* [auth0 roles permissions](auth0_roles_permissions.md) - Manage permissions within the role resource + diff --git a/docs/auth0_roles_permissions_remove.md b/docs/auth0_roles_permissions_remove.md new file mode 100644 index 000000000..254027823 --- /dev/null +++ b/docs/auth0_roles_permissions_remove.md @@ -0,0 +1,48 @@ +--- +layout: default +--- +## auth0 roles permissions remove + +Remove a permission from a role + +### Synopsis + +Remove an existing permission defined in one of your APIs. +To remove a permission try: + + auth0 roles permissions remove -p + +``` +auth0 roles permissions remove [flags] +``` + +### Examples + +``` +auth0 roles permissions remove -p +auth0 roles permissions rm +``` + +### Options + +``` + -a, --api-id string API Identifier. + -h, --help help for remove + -p, --permissions strings Permissions. +``` + +### Options inherited from parent commands + +``` + --debug Enable debug mode. + --force Skip confirmation. + --format string Command output format. Options: json. + --no-color Disable colors. + --no-input Disable interactivity. + --tenant string Specific tenant to use. +``` + +### SEE ALSO + +* [auth0 roles permissions](auth0_roles_permissions.md) - Manage permissions within the role resource + diff --git a/docs/auth0_users_create.md b/docs/auth0_users_create.md index c58f60c3f..a17bf22d2 100644 --- a/docs/auth0_users_create.md +++ b/docs/auth0_users_create.md @@ -25,7 +25,7 @@ auth0 users create -n "John Doe" --e john@example.com --connection "Username-Pas ### Options ``` - -c, --connection string Name of the connection this user should be created in. + -c, --connection string Name of the connection this user should be created in. Social connections are not supported. -e, --email string The user's email. -h, --help help for create -n, --name string The user's full name. diff --git a/docs/auth0_users_update.md b/docs/auth0_users_update.md index b7058bac9..5538ec24e 100644 --- a/docs/auth0_users_update.md +++ b/docs/auth0_users_update.md @@ -25,7 +25,7 @@ auth0 users update -n John Doe --email john.doe@example.com ### Options ``` - -c, --connection string Name of the connection this user should be created in. + -c, --connection string Name of the connection this user should be created in. Social connections are not supported. -e, --email string The user's email. -h, --help help for update -n, --name string The user's full name. diff --git a/internal/cli/users.go b/internal/cli/users.go index ede0d42e2..01a42769a 100644 --- a/internal/cli/users.go +++ b/internal/cli/users.go @@ -21,7 +21,7 @@ var ( Name: "Connection", LongForm: "connection", ShortForm: "c", - Help: "Name of the connection this user should be created in.", + Help: "Name of the connection this user should be created in. Social connections are not supported.", IsRequired: true, } userEmail = Flag{