auth0-deploy-cli 8.4.3 → 8.5.0

package/docs/resource-specific-documentation.md

@@ -1,284 +0,0 @@
-# Resource-specific Documentation
-
-In general, the Deploy CLI resource configuration files closely match the payload schemas of the [Management API](https://auth0.com/docs/api/management/v2).
-
-However, there are some notable nuances to be aware of:
-
-## Client Grants
-
-The Deploy CLI's own client grant is intentionally not exported nor configurable by itself. This is done to prevent breaking changes, otherwise the tool could potentially revoke access or otherwise crash in the midst of an import. In a multi-tenant, multi-environment context, it is expect that new tenants will have a designated client already established for the Deploy CLI, as mentioned in the [getting started instructions](./../README.md#create-a-dedicated-auth0-application).
-
-## Prompts
-
-Multilingual custom text prompts follow a particular hierarchy. Under the root-level `prompts` resource property is a proprietary `customText` property that is used to bundle custom text translations with other prompts settings. Underneath `customText` is the two-character language code. Thirdly is the prompt ID, followed by the screen ID, followed by text ID.
-
-RenderSettings of a prompt-screen follow a particular hierarchy. Under the root-level `prompts` we store `screenRenderers` property that is used to configure the rendering settings of a given prompt & screen. Thirdly is the prompt Name, followed by the screen Name mapped to the respective renderer configs file. Refer [more](https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens) on this.
-
-**Hierarchy**
-
-```yaml
-prompts:
-  customText:
-    <LANGUAGE>: # two character language code
-      <PROMPT_ID>: # prompt ID
-        <SCREEN_ID>: # prompt screen ID
-          <TEXT_ID>: 'Some text'
-    screenRenderers:
-      - <PROMPT-NAME>:
-          <SCREEN-NAME>: ./prompts/screenRenderSettings/promptName_screenName.json #Add the renderer configs for a given prompt & a given screen
-```
-
-**YAML Example**
-
-```
-Folder structure when in YAML mode.
-
-./prompts/
-    /screenRenderSettings
-        /signup-id_signup-id.json
-        /login-id_login-id.json
-        /login-passwordless_login-passwordless-email-code.json
-        /login-passwordless_login-passwordless-sms-otp.json
-        /login-password_login-password.json
-        /signup-password_signup-password.json
-./tenant.yaml
-```
-
-```yaml
-# Contents of ./tenant.yaml
-prompts:
-  identifier_first: true
-  universal_login_experience: classic
-  customText:
-    en:
-      login:
-        login:
-          description: Login description in english
-          buttonText: Button text
-      mfa:
-        mfa-detect-browser-capabilities:
-          pickAuthenticatorText: 'Try another method'
-          reloadButtonText: 'Reload'
-          noJSErrorTitle: 'JavaScript Required'
-        mfa-login-options:
-          pageTitle: 'Log in to ${clientName}'
-          authenticatorNamesSMS: 'SMS'
-  screenRenderers:
-    - signup-id:
-        signup-id: ./prompts/screenRenderSettings/signup-id_signup-id.json
-    - login-passwordless:
-        login-passwordless-email-code: ./prompts/screenRenderSettings/login-passwordless_login-passwordless-email-code.json
-        login-passwordless-sms-otp: ./prompts/screenRenderSettings/login-passwordless_login-passwordless-sms-otp.json
-```
-
-**Directory Example**
-
-```
-Folder structure when in directory mode.
-
-./prompts/
-    /screenRenderSettings
-        /signup-id_signup-id.json
-        /login-id_login-id.json
-        /login-passwordless_login-passwordless-email-code.json
-        /login-passwordless_login-passwordless-sms-otp.json
-        /login-password_login-password.json
-        /signup-password_signup-password.json
-    /custom-text.json
-    /prompts.json
-```
-
-Contents of `promptName_screenName.json`
-
-```json
-{
-  "prompt": "signup-id",
-  "screen": "signup-id",
-  "rendering_mode": "advanced",
-  "context_configuration": [
-    "branding.settings",
-    "branding.themes.default"
-  ],
-  "default_head_tags_disabled": false,
-  "head_tags": [
-    {
-      "tag": "script",
-      "attributes": {
-        "src": "URL_TO_YOUR_ASSET",
-        "async": true,
-        "defer": true,
-        "integrity": [
-          "ASSET_SHA"
-        ]
-      }
-    }
-  ]
-}
-```
-
-
-
-## Databases
-
-When managing database connections, the values of `options.customScripts` point to specific javascript files relative to
-the path of the output folder. Otherwise, the payload closely matches that of the [Management API](https://auth0.com/docs/api/management/v2#!/Connections/post_connections).
-
-**YAML Example**
-
-```
-Folder structure when in YAML mode.
-
-./databases/
-    /Username-Password-Authentication
-        /change_password.js
-        /create.js
-        /delete.js
-        /get_user.js
-        /login.js
-        /verify.js
-./tenant.yaml
-```
-
-```yaml
-# Contents of ./tenant.yaml
-databases:
-  - name: Username-Password-Authentication
-    # ...
-    options:
-      # ...
-      customScripts:
-        change_password: ./databases/Username-Password-Authentication/change_password.js
-        create: ./databases/Username-Password-Authentication/create.js
-        delete: ./databases/Username-Password-Authentication/delete.js
-        get_user: ./databases/Username-Password-Authentication/get_user.js
-        login: ./databases/Username-Password-Authentication/login.js
-        verify: ./databases/Username-Password-Authentication/verify.js
-```
-
-**Directory Example**
-
-```
-Folder structure when in directory mode.
-
-./database-connections/
-    ./Username-Password-Authentication/
-        ./change_password.js
-        ./create.js
-        ./database.json
-        ./delete.js
-        ./get_user.js
-        ./login.js
-        ./verify.js
-```
-
-Contents of `database.json`
-
-```json
-{
-  "options": {
-    "customScripts": {
-      "change_password": "./change_password.js",
-      "create": "./create.js",
-      "delete": "./delete.js",
-      "get_user": "./get_user.js",
-      "login": "./login.js",
-      "verify": "./verify.js"
-    }
-  }
-}
-```
-
-## Universal Login
-
-### Pages
-
-When overriding the Universal Login with custom HTML, the error, login, multi-factor authentication and password reset
-contents are organized in specific HTML pages.
-
-**YAML Example**
-
-```
-Folder structure when in YAML mode.
-
-./pages/
-    /error_page.html
-    /guardian_multifactor.html
-    /login.html
-    /password_reset.html
-./tenant.yaml
-```
-
-```yaml
-# Contents of ./tenant.yaml
-pages:
-  - name: error_page
-    html: ./pages/error_page.html
-    show_log_link: false
-    url: https://mycompany.org/error
-  - name: guardian_multifactor
-    enabled: true
-    html: ./pages/guardian_multifactor.html
-  - name: login
-    enabled: false
-    html: ./pages/login.html
-  - name: password_reset
-    enabled: true
-    html: ./pages/password_reset.html
-```
-
-**Directory Example**
-
-```
-Folder structure when in directory mode.
-
-./pages/
-    ./error_page.html
-    ./error_page.json
-    ./guardian_multifactor.html
-    ./guardian_multifactor.json
-    ./login.html
-    ./login.json
-    ./password_reset.html
-    ./password_reset.json
-```
-
-Contents of `login.json`
-
-```json
-{
-  "name": "login",
-  "enabled": false,
-  "html": "./login.html"
-}
-```
-
-Contents of `error_page.json`
-
-```json
-{
-  "html": "./error_page.html",
-  "show_log_link": false,
-  "url": "https://mycompany.org/error",
-  "name": "error_page"
-}
-```
-
-Contents of `guardian_multifactor.json`
-
-```json
-{
-  "enabled": true,
-  "html": "./guardian_multifactor.html",
-  "name": "guardian_multifactor"
-}
-```
-
-Contents of `password_reset.json`
-
-```json
-{
-  "enabled": true,
-  "html": "./password_reset.html",
-  "name": "password_reset"
-}
-```

package/docs/terraform-provider.md

@@ -1,20 +0,0 @@
-# Auth0 Terraform Provider
-
-The Deploy CLI is not the only tool available for managing your Auth0 tenant configuration, there is also an [officially supported Terraform Provider](https://github.com/auth0/terraform-provider-auth0). [Terraform](https://terraform.io/) is a third-party tool for representing your cloud resources’s configurations as code. It has an established plug-in framework that supports a wide array of cloud providers, including Auth0.
-
-Both the Deploy CLI and Terraform Provider exist to help you manage your Auth0 tenant configurations, but each has their own set of pros and cons.
-
-You may want to consider the Auth0 Terraform Provider if:
-
-- Your development workflows already leverages Terraform
-- Your tenant management needs are granular or only pertain to a few specific resources
-
-You may **not** want to consider the Auth0 Terraform Provider if:
-
-- Your development workflow does not use Terraform, requiring extra setup upfront
-- Your development workflows are primarily concerned with managing your tenants in bulk
-- Your tenant has lots of existing resources, may require significant effort to “import”
-
----
-
-[[table of contents]](../README.md#documentation)

package/docs/using-as-cli.md

@@ -1,89 +0,0 @@
-# Using as a CLI
-
-The Deploy CLI can be used as a standalone command line utility. Doing so provides a simple way to manage your Auth0 tenant configuration in CI/CD workflows. Refer to the [Configuring the Deploy CLI](./configuring-the-deploy-cli.md) documentation for a comprehensive list of configuration settings.
-
-## `export` command
-
-Fetching configurations from Auth0 tenant to the local machine.
-
-### `--output_folder`, `-o`
-
-Path. Specifies the target directory for configuration files to be written to.
-
-### `--config_file`, `-c`
-
-Path. Specifies the user-defined configuration file (`config.json`). Refer to the list of [all configurable properties](./configuring-the-deploy-cli.md).
-
-### `--format`, `-f`
-
-Options: yaml or directory. Determines the file format of the exported resource configuration files. See: [Available Resource Config Formats](available-resource-config-formats).
-
-### `--export_ids`, `-e`
-
-Boolean. When enabled, will export the identifier fields for each resource. Default: `false`.
-
-### `--env`
-
-Boolean. Indicates if the tool should ingest environment variables or not. Default: `true`.
-
-### `--debug`
-
-Boolean. Enables more verbose error logging; useful during troubleshooting. Default: `false`.
-
-### `--proxy_url`, `-p`
-
-A url for proxying requests. Only set this if you are behind a proxy.
-
-### Examples
-
-```shell
-# Fetching Auth0 tenant configuration in the YAML format
-a0deploy export -c=config.json --format=yaml --output_folder=local
-
-# Fetching Auth0 tenant configuration in directory (JSON) format
-a0deploy export -c=config.json --format=directory --output_folder=local
-
-# Fetching Auth0 tenant configurations with IDs of all assets
-a0deploy export -c=config.json --format=yaml --output_folder=local --export_ids=true
-```
-
-## `import` command
-
-Applying configurations from local machine to Auth0 tenant.
-
-### `--input_file`, `-i`
-
-Path. Specifies the location of the resource configuration files. For YAML formats, this will point to the `tenant.yaml` file, for directory formats, this will point to the resource configuration directory.
-
-### `--config_file`, `-c`
-
-Path. Specifies the user-defined configuration file (config.json). Refer to the list of [all configurable properties](./configuring-the-deploy-cli.md).
-
-### `--env`
-
-Boolean. Indicates if the tool should ingest environment variables or not. Default: `true`.
-
-### `--proxy_url`, `-p`
-
-A url for proxying requests. Only set this if you are behind a proxy.
-
-### `--debug`
-
-Boolean. Enables more verbose error logging; useful during troubleshooting. Default: `false`.
-
-### Examples
-
-```shell
-# Deploying configuration for YAML formats
-a0deploy import -c=config.json --input_file=local/tenant.yaml
-
-# Deploying configuration for directory format
-a0deploy import -c=config.json --input_file=local
-
-# Deploying configuration with environment variables ignored
-a0deploy import -c=config.json --input_file=local/tenant.yaml --env=false
-```
-
----
-
-[[table of contents]](../README.md#documentation)

package/docs/using-as-node-module.md

@@ -1,114 +0,0 @@
-# Using as a Node Module
-
-The Deploy CLI can not only be used as a standalone CLI, but as a node module. Doing so allows you to manage Auth0 resources within expressive node scripts. Refer to the [Configuring the Deploy CLI](./configuring-the-deploy-cli.md) documentation for a comprehensive list of configuration settings.
-
-## `dump` function
-
-Fetches configurations from Auth0 tenant to the local machine.
-
-### Example
-
-```ts
-import { dump } from 'auth0-deploy-cli';
-
-dump({
-  output_folder: './local',
-  format: 'yaml',
-  config: {
-    AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
-    AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
-    AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
-  },
-})
-  .then(() => {
-    console.log('Auth0 configuration export successful');
-  })
-  .catch((err) => {
-    console.log('Error during Auth0 configuration export:', err);
-  });
-```
-
-## Argument parameters
-
-#### `format`
-
-Options: `yaml` or `directory`. Determines the file format of the exported resource configuration files. See: [Available Resource Configuration Formats](available-resource-config-formats).
-
-#### `output_folder`
-
-Path. Specifies the target directory for configuration files to be written to.
-
-#### `config`
-
-Object. Configures behavior of utility. Refer to the list of [all configurable properties](./configuring-the-deploy-cli.md).
-
-#### `config_file`
-
-Path. Specifies the user-defined configuration file (config.json). Refer to the list of [all configurable properties](./configuring-the-deploy-cli.md).
-
-#### `export_ids`
-
-Boolean: When enabled, will export the identifier fields for each resource. Default: false.
-
-#### `env`
-
-Boolean. Indicates if the tool should ingest environment variables or not. Default: `false`.
-
-#### `proxy_url`
-
-A url for proxying requests. Only set this if you are behind a proxy.
-
-## `deploy` function
-
-Applies configurations from local machine to Auth0 tenant.
-
-### Argument parameters
-
-#### `input_file`
-
-Path. Specifies the location of the resource configuration files. For YAML formats, this will point to the tenant.yaml file. For directory formats, this will point to the resource configuration directory.
-
-#### `config`
-
-Object. Configures behavior of utility. Refer to the list of [all configurable properties](./configuring-the-deploy-cli.md).
-
-#### `config_file`
-
-Path. Specifies the user-defined configuration file (config.json). Refer to the list of [all configurable properties](./configuring-the-deploy-cli.md).
-
-#### `export_ids`
-
-Boolean: When enabled, will export the identifier fields for each resource. Default: `false`.
-
-#### `env`
-
-Boolean. Indicates if the tool should ingest environment variables or not. Default: `false`.
-
-#### `proxy_url`
-
-A url for proxying requests. Only set this if you are behind a proxy.
-
-### Example
-
-```ts
-import { deploy } from 'auth0-deploy-cli';
-
-deploy({
-  input_file: './local/tenant.yaml',
-  config: {
-    AUTH0_DOMAIN: '<YOUR_AUTH0_TENANT_DOMAIN>',
-    AUTH0_CLIENT_ID: '<YOUR_AUTH0_CLIENT_ID>',
-    AUTH0_CLIENT_SECRET: '<YOUR_AUTH0_CLIENT_SECRET>',
-  },
-})
-  .then(() => {
-    console.log('Auth0 configuration applied to tenant successful');
-  })
-  .catch((err) => {
-    console.log('Error when applying configuration to Auth0 tenant:', err);
-  });
-```
-
----
-
-[[table of contents]](../README.md#documentation)

package/docs/v8_MIGRATION_GUIDE.md

@@ -1,46 +0,0 @@
-# V8 Migration Guide
-
-Guide to migrating from `7.x` to `8.x`
-
-- [General](#general)
-    - [Node 18 or newer is required](#node-18-or-newer-is-required)
-    - [Auth0 V4 Migration Guide](https://github.com/auth0/node-auth0/blob/master/v4_MIGRATION_GUIDE.md)
-- [Management Resources](#management-resources)
-    - [EmailProvider](#emailProvider)
-    - [Migrations](#migrations)
-
-## General
-
-### Node 18 or newer is required
-
-Node 18 LTS and newer LTS releases are supported.
-
-## Management Resources
-
-| Resource      | Change           | Description                                   |
-|---------------|------------------|-----------------------------------------------|
-| emailProvider | delete operation | Delete operation is deprecated on auth0 `4.x` |
-| migrations    | removed support  | Not supported on auth0 `4.x`                  |
-
-#### Note: Other resources from `7.x` are not affected and no changes are required.
-
-#### emailProvider
-
-The `delete` operation on the `emailProvider` resource will disable the email provider instead of deleting it.
-This is because the email provider deletion operation is deprecated on auth0 `4.x`. User can disable the email provider
-by email provider setting the `enabled` property to `false` from the configuration file.
-
-```yaml
-  emailProvider:
-    # other properties
-    enabled: false
-```
-
-Rest of the operations on emailProvider resource will work the same as `7.x`.
-
-#### migrations
-
-The `migrations` resource is not supported on auth0 `4.x`. It's recommended to remove the `migrations` resource from the
-configuration file. If it's not removed, the deploy CLI will ignore the `migrations` resource for operations.
-
-