auth0-deploy-cli 8.4.3 → 8.5.0

package/examples/directory/README.md

@@ -1,167 +0,0 @@
-# Auth0 Deploy CLI via Directory Structure
-
-This README will document how to use the Directory Option of the Auth0-deploy-cli tool. Please refer to the [README.md](README.md) for more information on the Auth0 Deploy CLI.
-
-# Overview
-The directory option supports exporting and importing the Auth0 tenant configuration into a pre-defined directory structure.
-
-There is more extensive documentation online for how the files are expected to be laid out to work with the source control configuration utilities [here](https://auth0.com/docs/extensions/github-deploy).
-
-Here is a simple overview:
-
-```
-repository =>
-  clients
-    client1.json
-    client2.json
-  connections
-    connection1.json
-  database-connections
-    connection1
-      database.json
-      create.js
-      delete.js
-      get_user.js
-      login.js
-      verify.js
-  emails
-    provider.json
-    verify_email.json
-    verify_email.html
-    welcome_email.json
-    welcome_email.html
-  grants
-    grant1.json
-  pages
-    login.html
-    login.json
-    password_reset.html
-    password_reset.json
-  resource-servers
-    resource_server1.json
-    resource_server2.json
-  guardian
-    factors
-      sms.json
-      email.json
-      otp.json
-      push-notification.json
-    provider
-      sms-twilio.json
-    templates
-      sms.json
-    phoneFactorMessageTypes.json
-    phoneFactorSelectedProvider.json
-    policies.json
-  actions
-    action1
-      code.js
-      current_version.js
-    action1.json
-  triggers
-    triggers.json
-```
-
-## 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 directory -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
-Included in this GitHub directory is an example structure.
-
-### Instructions
-
-1. Copy config.json.example and fill out details
-2. Run deploy
-```bash
-a0deploy import -c config.json -i .
-```
-
-# 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_KEYWORD_REPLACE_MAPPINGS": {
-    "YOUR_ARRAY_KEY": [
-      "http://localhost:8080",
-      "https://somedomain.com"
-    ],
-    "YOUR_STRING_KEY": "some environment specific string"
-  },
-  "AUTH0_ALLOW_DELETE": false,
-  "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##`.
-
-Use the `@` symbols to inject the full, literal value regardless of type (string, number, object, array).
-
-Use the `#` symbols for string interpolation.
-
-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/directory/actions/action-example/code.js

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

package/examples/directory/actions/action-example.json

@@ -1,24 +0,0 @@
-{
-  "name": "action-example",
-  "code": "directory/actions/action-example/code.js",
-  "status": "built",
-  "dependencies": [
-    {
-      "name": "lodash",
-      "version": "4.17.21"
-    }
-  ],
-  "secrets": [
-    {
-      "name": "MY_SECRET",
-      "value": "_VALUE_NOT_SHOWN_"
-    }
-  ],
-  "supported_triggers": [
-    {
-      "id": "post-login",
-      "version": "v1"
-    }
-  ],
-  "deployed": true
-}

package/examples/directory/clients/My SPA.json

@@ -1,40 +0,0 @@
-{
-	"allowed_clients": [],
-	"allowed_logout_urls": [
-		"https://##ENV##.myapp.com/logout"
-	],
-	"allowed_origins": [
-		"https://##ENV##.myapp.com/"
-	],
-	"app_type": "spa",
-	"callback_url_template": false,
-	"callbacks": [
-		"https://##ENV##.myapp.com/callback"
-	],
-	"cross_origin_auth": false,
-	"custom_login_page_on": true,
-	"description": "My SPA Application",
-	"global": false,
-	"grant_types": [
-		"authorization_code",
-		"implicit",
-		"refresh_token"
-	],
-	"is_first_party": true,
-	"is_token_endpoint_ip_header_trusted": false,
-	"jwt_configuration": {
-		"alg": "RS256",
-		"lifetime_in_seconds": 36000,
-		"secret_encoded": false
-	},
-	"logo_uri": "https://myapp.com/logo.png",
-	"name": "My SPA",
-	"oidc_conformant": true,
-	"sso": true,
-	"sso_disabled": false,
-	"tenant": "##AUTH0_TENANT_NAME##",
-	"token_endpoint_auth_method": "none",
-	"web_origins": [
-		"https://##ENV##.myapp.com"
-	]
-}

package/examples/directory/config.json.example

@@ -1,20 +0,0 @@
-{
-  "AUTH0_DOMAIN": "<YOUR_TENANT>.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/directory/connections/facebook.json

@@ -1,60 +0,0 @@
-{
-  "options": {
-    "scope": "email,user_birthday,user_hometown,user_location,user_friends,user_likes",
-    "client_id": "123456789",
-    "public_profile": false,
-    "email": true,
-    "user_birthday": true,
-    "user_website": false,
-    "user_hometown": true,
-    "user_location": true,
-    "user_work_history": false,
-    "user_education_history": false,
-    "user_about_me": false,
-    "ads_management": false,
-    "ads_read": false,
-    "manage_pages": false,
-    "pages_show_list": false,
-    "pages_manage_cta": false,
-    "pages_messaging": false,
-    "pages_messaging_phone_number": false,
-    "pages_messaging_subscriptions": false,
-    "publish_actions": false,
-    "publish_pages": false,
-    "read_audience_network_insights": false,
-    "read_custom_friendlists": false,
-    "read_insights": false,
-    "read_page_mailboxes": false,
-    "rsvp_event": false,
-    "user_actions-books": false,
-    "user_actions-fitness": false,
-    "user_actions-music": false,
-    "user_actions-news": false,
-    "user_actions-video": false,
-    "user_events": false,
-    "user_friends": true,
-    "user_games_activity": false,
-    "user_likes": true,
-    "user_managed_groups": false,
-    "user_tagged_places": false,
-    "user_photos": false,
-    "user_posts": false,
-    "user_relationships": false,
-    "user_relationship_details": false,
-    "user_religion_politics": false,
-    "user_status": false,
-    "user_videos": false,
-    "manage_notifications": false,
-    "read_stream": false,
-    "read_mailbox": false,
-    "user_groups": false,
-    "client_secret": "SOME_SECRET",
-    "publish_video": false
-  },
-  "strategy": "facebook",
-  "name": "facebook",
-  "is_domain_connection": false,
-  "enabled_clients": [
-    "My SPA"
-  ]
-}

package/examples/directory/database-connections/users/change_email.js

@@ -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/directory/database-connections/users/change_password.js

@@ -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/directory/database-connections/users/create.js

@@ -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/directory/database-connections/users/database.json

@@ -1,20 +0,0 @@
-{
-  "options": {
-    "requires_username": false,
-    "strategy_version": 2,
-    "enabledDatabaseCustomization": true,
-    "customScripts": {
-      "login": "./login.js",
-      "get_user": "./get_user.js"
-    },
-    "import_mode": true
-  },
-  "strategy": "auth0",
-  "name": "users",
-  "realms": [
-    "users"
-  ],
-  "enabled_clients": [
-    "My SPA"
-  ]
-}

package/examples/directory/database-connections/users/delete.js

@@ -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/directory/database-connections/users/get_user.js

@@ -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/directory/database-connections/users/login.js

@@ -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/directory/database-connections/users/verify.js

@@ -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/directory/emails/blocked_account.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/blocked_account.json

@@ -1,10 +0,0 @@
-{
-  "template": "blocked_account",
-  "from": "",
-  "subject": "",
-  "resultUrl": "",
-  "syntax": "liquid",
-  "body": "./blocked_account.html",
-  "urlLifetimeInSeconds": 432000,
-  "enabled": true
-}

package/examples/directory/emails/enrollment_email.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/enrollment_email.json

@@ -1,8 +0,0 @@
-{
-  "template": "enrollment_email",
-  "from": "",
-  "subject": "",
-  "syntax": "liquid",
-  "body": "./enrollment_email.html",
-  "enabled": true
-}

package/examples/directory/emails/mfa_oob_code.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/mfa_oob_code.json

@@ -1,8 +0,0 @@
-{
-  "template": "mfa_oob_code",
-  "from": "",
-  "subject": "",
-  "syntax": "liquid",
-  "body": "./mfa_oob_code.html",
-  "enabled": true
-}

package/examples/directory/emails/provider.json

@@ -1,10 +0,0 @@
-{
-	"name": "smtp",
-	"enabled": true,
-	"credentials": {
-		"smtp_host": "smtp.server.com",
-		"smtp_port": 25,
-		"smtp_user": "smtp_user",
-		"smtp_pass": "smtp_secret_password"
-	}
-}

package/examples/directory/emails/reset_email.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/reset_email.json

@@ -1,10 +0,0 @@
-{
-  "template": "reset_email",
-  "from": "",
-  "subject": "",
-  "resultUrl": "",
-  "syntax": "liquid",
-  "body": "./reset_email.html",
-  "urlLifetimeInSeconds": 432000,
-  "enabled": true
-}

package/examples/directory/emails/stolen_credentials.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/stolen_credentials.json

@@ -1,8 +0,0 @@
-{
-  "template": "stolen_credentials",
-  "from": "",
-  "subject": "",
-  "syntax": "liquid",
-  "body": "./stolen_credentials.html",
-  "enabled": true
-}

package/examples/directory/emails/verify_email.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/verify_email.json

@@ -1,10 +0,0 @@
-{
-  "template": "verify_email",
-  "from": "",
-  "subject": "",
-  "resultUrl": "",
-  "body": "./verify_email.html",
-  "urlLifetimeInSeconds": 432000,
-  "syntax": "liquid",
-  "enabled": true
-}

package/examples/directory/emails/verify_email_by_code.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/verify_email_by_code.json

@@ -1,8 +0,0 @@
-{
-  "template": "verify_email_by_code",
-  "from": "",
-  "subject": "",
-  "syntax": "liquid",
-  "body": "./verify_email_by_code.html",
-  "enabled": true
-}

package/examples/directory/emails/welcome_email.html

@@ -1,5 +0,0 @@
-<html>
-<body>
-Example Email
-</body>
-</html>

package/examples/directory/emails/welcome_email.json

@@ -1,8 +0,0 @@
-{
-  "template": "welcome_email",
-  "from": "",
-  "subject": "",
-  "body": "./welcome_email.html",
-  "syntax": "liquid",
-  "enabled": true
-}

package/examples/directory/grants/m2m_myapp_api.json

@@ -1,7 +0,0 @@
-{
-  "client_id": "My M2M",
-  "audience": "https://##ENV##.myapp.com/api/v1",
-  "scope": [
-    "update:account"
-  ]
-}

package/examples/directory/guardian/factors/email.json

@@ -1,4 +0,0 @@
-{
-  "name": "email",
-  "enabled": true
-}

package/examples/directory/guardian/factors/otp.json

@@ -1,4 +0,0 @@
-{
-  "name": "otp",
-  "enabled": true
-}

package/examples/directory/guardian/factors/push-notification.json

@@ -1,4 +0,0 @@
-{
-  "name": "push-notification",
-  "enabled": true
-}

package/examples/directory/guardian/factors/sms.json

@@ -1,4 +0,0 @@
-{
-  "name": "sms",
-  "enabled": true
-}

package/examples/directory/guardian/phoneFactorMessageTypes.json

@@ -1,6 +0,0 @@
-{
-  "message-types": [
-    "sms",
-    "voice"
-  ]
-}

package/examples/directory/guardian/phoneFactorSelectedProvider.json

@@ -1,3 +0,0 @@
-{
-  "provider": "twilio"
-}

package/examples/directory/guardian/policies.json

@@ -1,5 +0,0 @@
-{
-  "policies": [
-    "all-applications"
-  ]
-}

package/examples/directory/guardian/providers/sms-twilio.json

@@ -1,7 +0,0 @@
-{
-  "name": "sms",
-  "provider": "twilio",
-  "auth_token": "test",
-  "sid": "test",
-  "messaging_service_sid": "test"
-}

package/examples/directory/guardian/templates/sms.json

@@ -1,5 +0,0 @@
-{
-  "name": "sms",
-  "enrollment_message": "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
-  "verification_message": "{{code}} is your verification code for {{tenant.friendly_name}}"
-}

package/examples/directory/hooks/client-credentials-exchange.js

@@ -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/directory/hooks/client-credentials-exchange.json

@@ -1,12 +0,0 @@
-{
-  "triggerId": "credentials-exchange",
-  "name": "cce hook",
-  "script": "./client-credentials-exchange.js",
-  "enabled": true,
-  "secrets": {
-    "api-key": "my custom api key"
-  },
-  "dependencies": {
-    "bcrypt": "3.0.6"
-  }
-}

package/examples/directory/pages/login.html

@@ -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/directory/pages/login.json

@@ -1,4 +0,0 @@
-{
-  "name": "login",
-  "enabled": true
-}