Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #335

Merged
merged 1 commit into from
Jul 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/auth0_branding_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/auth0_roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

35 changes: 35 additions & 0 deletions docs/auth0_roles_permissions.md
Original file line number Diff line number Diff line change
@@ -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

48 changes: 48 additions & 0 deletions docs/auth0_roles_permissions_add.md
Original file line number Diff line number Diff line change
@@ -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 <role-id> -p <permission-name>

```
auth0 roles permissions add [flags]
```

### Examples

```
auth0 roles permissions add <role-id> -p <permission-name>
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

44 changes: 44 additions & 0 deletions docs/auth0_roles_permissions_list.md
Original file line number Diff line number Diff line change
@@ -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 <role-id>

```
auth0 roles permissions list [flags]
```

### Examples

```
auth0 roles permissions list <role-id>
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

48 changes: 48 additions & 0 deletions docs/auth0_roles_permissions_remove.md
Original file line number Diff line number Diff line change
@@ -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 <role-id> -p <permission-name>

```
auth0 roles permissions remove [flags]
```

### Examples

```
auth0 roles permissions remove <role-id> -p <permission-name>
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

2 changes: 1 addition & 1 deletion docs/auth0_users_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ auth0 users create -n "John Doe" --e [email protected] --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.
Expand Down
2 changes: 1 addition & 1 deletion docs/auth0_users_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ auth0 users update -n John Doe --email [email protected]
### 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.
Expand Down
2 changes: 1 addition & 1 deletion internal/cli/users.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down