auth0 / auth0-deploy-cli

The Auth0 Deploy CLI is a tool that helps you manage your Auth0 tenant configuration. It integrates into your development workflows as a standalone CLI or as a node module.
MIT License
248 stars 154 forks source link

`EXCLUDED_PROPS` not respecting `clients.client_metadata` when doing a deploy #968

Closed marcossv9 closed 1 week ago

marcossv9 commented 1 month ago

Checklist

Description

I have excluded the following resources from being managed by auth0-deploy-cli:

  "AUTH0_DOMAIN": "xxxx.us.auth0.com",
  "AUTH0_CLIENT_ID": "xxxx",
  "AUTH0_ALLOW_DELETE": true,
  "AUTH0_EXCLUDED": [
    "hooks",
    "rules"
  ],
  "AUTH0_KEYWORD_REPLACE_MAPPINGS": {
    ~ALL_THE_MAPPINGS_HERE~
  }
  "EXCLUDED_PROPS": {
    "clients": [
      "client_secret",
      "client_metadata"
    ],
    "connections": [
      "options.client_secret"
    ]
  }

So, the thing is that when I run a deploy the current client_metadata values are deleted. That shouldn't happen if I'm explicitly saying to exclude that to be managed. image

Expectation

client_metadata values should remain unchanged after deployment of tenant-config.

Reproduction

  1. run a dump (clients.client_metadata actually contains valid values in the remote tenant config)
  2. run a deploy

Deploy CLI version

7.24.3

Node version

v18.17.1

marcossv9 commented 3 weeks ago

FYI, opened up a support ticket with Auth0 team. They are looking into it. Will post back here when I have news.

marcossv9 commented 1 week ago

I just got an update from Auth0 Support team.

They just found out that currently, the deploy CLI does not support EXCLUDED_PROPS for the client’s client_metadata import operation;

They can add this as a feature enhancement.

I have told them that there is no need for that, as due to time constraints we have decided to keep all the client_metadata values as mapping keywords for now and replace them across all tenants with different values.

Will close this for now, but if you need help, you will have to reach out to Support directly.