Database Settings Used for the Secrets in Custom DB are Deleted After an Update with Auth0 Deploy CLI Tool

Knowledge Articles
1

Overview

This article explains how to avoid losing database settings used for the secrets in Custom DB after an update with the Auth0 deploy CLI tool.

image
image3306×1776 351 KB

Applies To

  • Auth0 Deploy CLI
  • Custom DB
  • Database Settings

Solution

Deploy CLI does not export the database settings of a custom database. However, those settings should be added under the configuration field in the options section in the YAML or JSON files while importing the connection via the Auth0 deploy CLI.

YAML Example

databases:
  - name: "My DB"
    strategy: "auth0"
    enabled_clients:
      - "app1"
    options:
      configuration:
        key1: "value1"
        key2: "value2"
      customScripts:
        /* redacted for brevity */

JSON Example

{
  "name": "my DB",
  "strategy": "auth0",
  "enabled_clients": [
    "app1"
  ],
  "options": {
    "configuration": {
      "key1": "value1",
      "key2": "value2"
    },
    /* redacted for brevity */
  }
}