npm - auth0-deploy-cli - Versions diffs - 8.4.3 → 8.4.4 - Mend

auth0-deploy-cli 8.4.3 → 8.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (113) hide show

package/examples/directory/pages/password_reset.html DELETED Viewed

@@ -1,6 +0,0 @@
-<html>
-<body>
-<h1>This is just an example, go update your password reset page :)</h1>
-<h2>Env is @@ENV@@</h2>
-</body>
-</html>

package/examples/directory/pages/password_reset.json DELETED Viewed

@@ -1,4 +0,0 @@
-{
-  "name": "password_reset",
-  "enabled": false
-}

package/examples/directory/prompts/custom-text.json DELETED Viewed

@@ -1,9 +0,0 @@
-{
-  "en": {
-    "login-id": {
-      "login-id": {
-        "invalid-email-format": "Email is not valid."
-      }
-    }
-  }
-}

package/examples/directory/prompts/prompts.json DELETED Viewed

@@ -1,6 +0,0 @@
-{
-  "universal_login_experience": "new",
-  "identifier_first": false,
-  "webauthn_platform_first_factor": true,
-  "enable_ulp_wcag_compliance": false
-}

package/examples/directory/prompts/screenRenderSettings/login-id_login-id.json DELETED Viewed

@@ -1,33 +0,0 @@
-{
-  "prompt": "login-id",
-  "screen": "login-id",
-  "rendering_mode": "advanced",
-  "context_configuration": [
-    "branding.settings",
-    "branding.themes.default"
-  ],
-  "default_head_tags_disabled": true,
-  "head_tags": [
-    {
-      "tag": "script",
-      "attributes": {
-        "src": "http://127.0.0.1:8090/index.js",
-        "defer": true
-      }
-    },
-    {
-      "tag": "link",
-      "attributes": {
-        "rel": "stylesheet",
-        "href": "http://127.0.0.1:8090/index.css"
-      }
-    },
-    {
-      "tag": "meta",
-      "attributes": {
-        "name": "viewport",
-        "content": "width=device-width, initial-scale=1"
-      }
-    }
-  ]
-}

package/examples/directory/prompts/screenRenderSettings/signup-id_signup-id.json DELETED Viewed

@@ -1,20 +0,0 @@
-{
-  "prompt": "signup-id",
-  "screen": "signup-id",
-  "rendering_mode": "advanced",
-  "context_configuration": [],
-  "default_head_tags_disabled": false,
-  "head_tags": [
-    {
-      "tag": "script",
-      "attributes": {
-        "src": "URL_TO_YOUR_ASSET",
-        "async": true,
-        "defer": true,
-        "integrity": [
-          "ASSET_SHA"
-        ]
-      }
-    }
-  ]
-}

package/examples/directory/resource-servers/My API.json DELETED Viewed

@@ -1,19 +0,0 @@
-{
-    "name": "My API",
-    "identifier": "https://##ENV##.myapp.com/api/v1",
-    "allow_offline_access": false,
-    "skip_consent_for_verifiable_first_party_clients": true,
-    "token_lifetime": 86400,
-    "token_lifetime_for_web": 7200,
-    "signing_alg": "RS256",
-    "scopes": [
-      {
-        "value": "write:messages",
-        "description": "write messages"
-      },
-      {
-        "value": "read:messages",
-        "description": "read:messages"
-      }
-    ]
-  }

package/examples/directory/roles/Admin.json DELETED Viewed

@@ -1,14 +0,0 @@
-{
-  "name": "Admin",
-  "description": "App Admin",
-  "permissions": [
-    {
-      "permission_name": "write:messages",
-      "resource_server_identifier": "https://##ENV##.myapp.com/api/v1"
-    },
-    {
-      "permission_name": "read:messages",
-      "resource_server_identifier": "https://##ENV##.myapp.com/api/v1"
-    }
-  ]
-}

package/examples/directory/roles/User.json DELETED Viewed

@@ -1,10 +0,0 @@
-{
-    "name": "User",
-    "description": "App User",
-    "permissions": [
-      {
-        "permission_name": "read:messages",
-        "resource_server_identifier": "https://##ENV##.myapp.com/api/v1"
-      }
-    ]
-  }

package/examples/directory/rules/Enrich-Identity-Token.js DELETED Viewed

@@ -1,10 +0,0 @@
-function (user, context, callback) {
-  const env = @@ENV@@;
-  console.log(`env is ${env}`);
-  // Add Env to Token
-  context.idToken['https://myapp.com/env'] = @@ENV@@;
-  callback(new Error(`This is just an example from auth0-deploy-cli, don\'t use this rule!`), user, context);
-}

package/examples/directory/rules/Enrich-Identity-Token.json DELETED Viewed

@@ -1,7 +0,0 @@
-{
-	"enabled": true,
-	"name": "Enrich-Identity-Token",
-	"order": 1,
-	"stage": "login_success",
-  "script": "./Enrich-Identity-Token.js"
-}

package/examples/directory/rules-configs/SOME_SECRET.json DELETED Viewed

@@ -1,4 +0,0 @@
-{
-  "key": "THISDATA_API_KEY",
-  "value": "##MY_SECRET##"
-}

package/examples/directory/tenant.json DELETED Viewed

@@ -1,8 +0,0 @@
-{
-  "friendly_name": "My Company",
-  "support_email": "support@company.com",
-  "session_lifetime": 168,
-  "default_directory": "users",
-  "sandbox_version": "8",
-  "idle_session_lifetime": 72
-}

package/examples/directory/triggers/triggers.json DELETED Viewed

@@ -1,18 +0,0 @@
-{
-  "post-login": [
-    {
-      "action_name": "action-example",
-      "display_name": "action-example"
-    }
-  ],
-  "credentials-exchange": [],
-  "pre-user-registration": [],
-  "post-user-registration": [],
-  "post-change-password": [],
-  "send-phone-message": [
-    {
-      "action_name": "ldoorz",
-      "display_name": "ldoorz"
-    }
-  ]
-}

package/examples/yaml/README.md DELETED Viewed

@@ -1,111 +0,0 @@
-# Auth0 Deploy CLI using YAML
-This README will document how to use the YAML Option of the Auth0-deploy-cli tool. Please refer to the main project [README.md](../../README.md) for more information on the Auth0 Deploy CLI.
-# Overview
-The YAML option supports exporting and importing the Auth0 tenant configuration via a YAML file.
-For more information on YAML please refer to [http://yaml.org/](http://yaml.org/)
-## Example Export
-You can export your current tenant configuration. For example the following command will export your tenant configuration.
-`a0deploy export -c config.json -f yaml -o path/to/export`
-> NOTE: The config value `AUTH0_EXPORT_IDENTIFIERS: true` (or `--export_ids` option) can be used to export the identifier fields to the Auth0 objects. This means you won't be able to import these objects as the tool cannot find the existing objects by their id.
-> NOTE: Some of the settings cannot be exported for example emailProvider credentials, rulesConfigs values and others. After export you may need to update the `tenant.yaml` values if you experience schema errors on import.
-## Example Import
-Please refer to [tenant.yaml](tenant.yaml) for an example configuration.
-### Instructions
-1. Copy config.json.example and fill out details
-2. Run deploy
-```bash
-a0deploy import -c config.json -i tenant.yaml
-```
-# Usage
-## Config
-The config will need the client ID and secret from your newly created client (the client is named `auth0-deploy-cli-extension` if you used the extension).
-You can either set environment variables (ie in your terminal) or place the values in a config file anywhere on the filesystem.
-> NOTE: By default the tool will also merge in your current environment variables and override the config.json which have the same top key. You can disable this via the command line with the `--no-env` option.
-Here is the example of a config.json:
-```json
-{
-  "AUTH0_DOMAIN": "<your auth0 domain (e.g. fabrikam-dev.auth0.com) >",
-  "AUTH0_CLIENT_SECRET": "<your deploy client secret>",
-  "AUTH0_CLIENT_ID": "<your deploy client ID>",
-  "AUTH0_ALLOW_DELETE": false,
-  "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
-    "YOUR_ARRAY_KEY": [
-      "http://localhost:8080",
-      "https://somedomain.com"
-    ],
-    "YOUR_STRING_KEY": "some environment specific string"
-  },
-  "INCLUDED_PROPS": {
-    "clients": [ "client_secret" ]
-  },
-  "EXCLUDED_PROPS": {
-    "connections": [ "options.client_secret" ]
-  },
-  "AUTH0_EXCLUDED_RULES": [ "auth0-account-link-extension" ],
-  "AUTH0_EXCLUDED_CLIENTS": [ "auth0-account-link" ],
-  "AUTH0_EXCLUDED_RESOURCE_SERVERS": [ "SSO Dashboard API" ],
-  "AUTH0_EXCLUDED_DEFAULTS": ["emailProvider"]
-}
-```
-## Environment Variables and AUTH0_KEYWORD_REPLACE_MAPPINGS
-The `auth0-deploy-cli` supports environment variables replacements, also known as mappings. This means you can deploy the same Auth0 Tenant configuration across your environments (i.e. dev, uat, staging, and prod). The tool will automatically inject the right values for each environment (i.e callback urls).
-Environment variables can be set on the terminal and within the `config.json`. At run time the variables defined in your terminal and `config.json` will be merged. You can disable this via the command line with the `--no-env` option. The terminal variables will take priority over `config.json`
-There are two ways to use the keyword mappings in your Auth0 Tenant configuration files. You can inject values using `@@key@@` or `##key##`.
-If you use the `@` symbols, it will do a JSON.stringify on your value before replacing it. So if it is a string it will add quotes, if it is an array or object it will add braces.
-If you use the `#` symbol instead, it will do a literal replacement. It will not add quotes or brackets.
-For example, you could specify a different JWT timeout in your dev environment then prod for testing and a different environment URL:
-Client.json:
-```json
-{
-  ...
-  "callbacks": [
-    "##ENVIRONMENT_URL##/auth/callback"
-  ],
-  "jwt_configuration": {
-    "lifetime_in_seconds": @@JWT_TIMEOUT@@,
-    "secret_encoded": true
-  }
-  ...
-}
-```
-Dev Config.json:
-```json
-  "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
-    "ENVIRONMENT_URL": "http://dev.fabrikam.com",
-    "JWT_TIMEOUT": 120,
-    ...
-  }
-```
-Prod Config.json:
-```json
-  "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
-    "ENVIRONMENT_URL": "http://fabrikam.com",
-    "JWT_TIMEOUT": 3600,
-    ...
-  }
-```

package/examples/yaml/actions/action-example/code.js DELETED Viewed

@@ -1,4 +0,0 @@
-/** @type {PostLoginAction} */
-module.exports = async (event, context) => {
-  return {};
-};

package/examples/yaml/config.json.example DELETED Viewed

@@ -1,20 +0,0 @@
-{
-  "AUTH0_DOMAIN": "<YOUR_TENANT>.<YOUR_REGION>.auth0.com",
-  "AUTH0_CLIENT_ID": "<client_id>",
-  "AUTH0_CLIENT_SECRET": "<client_secret>",
-  "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
-    "AUTH0_TENANT_NAME": "<NAME>",
-    "ENV": "DEV"
-  },
-  "AUTH0_ALLOW_DELETE": false,
-  "INCLUDED_PROPS": {
-    "clients": [ "client_secret" ]
-  },
-  "AUTH0_EXCLUDED_RULES": [
-    "rule-1-name",
-    "rule-2-name"
-  ],
-  "EXCLUDED_PROPS": {
-    "connections": [ "options.client_secret" ]
-  }
-}

package/examples/yaml/databases/users/change_email.js DELETED Viewed

@@ -1,4 +0,0 @@
-function changeEmail(email, callback) {
-  const msg = 'Please implement the change email script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/databases/users/change_password.js DELETED Viewed

@@ -1,4 +0,0 @@
-function changePassword (email, newPassword, callback) {
-  const msg = 'Please implement the change password script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/databases/users/create.js DELETED Viewed

@@ -1,4 +0,0 @@
-function login(user, callback) {
-  const msg = 'Please implement the create script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/databases/users/delete.js DELETED Viewed

@@ -1,4 +0,0 @@
-function remove (id, callback) {
-  const msg = 'Please implement the delete script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/databases/users/get_user.js DELETED Viewed

@@ -1,4 +0,0 @@
-function getUser(email, callback) {
-  const msg = 'Please implement the get user script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/databases/users/login.js DELETED Viewed

@@ -1,4 +0,0 @@
-function login(email, password, callback) {
-  const msg = 'Please implement the login script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/databases/users/verify.js DELETED Viewed

@@ -1,4 +0,0 @@
-function login(email, callback) {
-  const msg = 'Please implement the verify script for this database connection';
-  return callback(new Error(msg));
-}

package/examples/yaml/emails/change_email.html DELETED Viewed

@@ -1,5 +0,0 @@
-<html>
-<body>
-test email
-</body>
-</html>

package/examples/yaml/hooks/client-credentials-exchange.js DELETED Viewed

@@ -1,22 +0,0 @@
-/**
-@param {object} client - information about the client
-@param {string} client.name - name of client
-@param {string} client.id - client id
-@param {string} client.tenant - Auth0 tenant name
-@param {object} client.metadata - client metadata
-@param {array|undefined} scope - array of strings representing the scope claim or undefined
-@param {string} audience - token's audience claim
-@param {object} context - additional authorization context
-@param {object} context.webtask - webtask context
-@param {function} cb - function (error, accessTokenClaims)
-*/
-module.exports = function(client, scope, audience, context, cb) {
-  var access_token = {};
-  access_token.scope = scope;
-  // Modify scopes or add extra claims
-  // access_token['https://example.com/claim'] = 'bar';
-  // access_token.scope.push('extra');
-  cb(null, access_token);
-};

package/examples/yaml/pages/error_page.html DELETED Viewed

@@ -1,6 +0,0 @@
-<html>
-<body>
-<h1>This is just an example, go update your error page :)</h1>
-<h2>Env is @@ENV@@</h2>
-</body>
-</html>

package/examples/yaml/pages/guardian_multifactor.html DELETED Viewed

@@ -1,6 +0,0 @@
-<html>
-<body>
-<h1>This is just an example, go update your MFA page :)</h1>
-<h2>Env is @@ENV@@</h2>
-</body>
-</html>

package/examples/yaml/pages/login.html DELETED Viewed

@@ -1,6 +0,0 @@
-<html>
-<body>
-<h1>This is just an example, go update your login page :)</h1>
-<h2>Env is @@ENV@@</h2>
-</body>
-</html>

package/examples/yaml/pages/password_reset.html DELETED Viewed

@@ -1,6 +0,0 @@
-<html>
-<body>
-<h1>This is just an example, go update your password reset page :)</h1>
-<h2>Env is @@ENV@@</h2>
-</body>
-</html>

package/examples/yaml/prompts/screenRenderSettings/login-id_login-id.json DELETED Viewed

@@ -1,33 +0,0 @@
-{
-  "prompt": "login-id",
-  "screen": "login-id",
-  "rendering_mode": "advanced",
-  "context_configuration": [
-    "branding.settings",
-    "branding.themes.default"
-  ],
-  "default_head_tags_disabled": true,
-  "head_tags": [
-    {
-      "tag": "script",
-      "attributes": {
-        "src": "http://127.0.0.1:8090/index.js",
-        "defer": true
-      }
-    },
-    {
-      "tag": "link",
-      "attributes": {
-        "rel": "stylesheet",
-        "href": "http://127.0.0.1:8090/index.css"
-      }
-    },
-    {
-      "tag": "meta",
-      "attributes": {
-        "name": "viewport",
-        "content": "width=device-width, initial-scale=1"
-      }
-    }
-  ]
-}

package/examples/yaml/prompts/screenRenderSettings/signup-id_signup-id.json DELETED Viewed

@@ -1,20 +0,0 @@
-{
-  "prompt": "signup-id",
-  "screen": "signup-id",
-  "rendering_mode": "advanced",
-  "context_configuration": [],
-  "default_head_tags_disabled": false,
-  "head_tags": [
-    {
-      "tag": "script",
-      "attributes": {
-        "src": "URL_TO_YOUR_ASSET",
-        "async": true,
-        "defer": true,
-        "integrity": [
-          "ASSET_SHA"
-        ]
-      }
-    }
-  ]
-}

package/examples/yaml/rules/enrich_tokens.js DELETED Viewed

@@ -1,10 +0,0 @@
-function (user, context, callback) {
-  const env = @@ENV@@;
-  console.log(`env is ${env}`);
-  // Add Env to Token
-  context.idToken['https://myapp.com/env'] = @@ENV@@;
-  callback(new Error(`This is just an example from auth0-deploy-cli, don\'t use this rule!`), user, context);
-}