{"id":31027080,"url":"https://github.com/willhackett/auth0-config-deploy","last_synced_at":"2025-09-13T18:51:19.884Z","repository":{"id":42862928,"uuid":"259508496","full_name":"willhackett/auth0-config-deploy","owner":"willhackett","description":"Configure, test \u0026 deploy Auth0 config via the Management API","archived":false,"fork":false,"pushed_at":"2023-12-15T11:44:55.000Z","size":1613,"stargazers_count":0,"open_issues_count":17,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-20T11:50:12.693Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/willhackett.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-28T02:19:54.000Z","updated_at":"2020-04-28T21:30:28.000Z","dependencies_parsed_at":"2023-02-13T11:46:06.582Z","dependency_job_id":null,"html_url":"https://github.com/willhackett/auth0-config-deploy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/willhackett/auth0-config-deploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willhackett%2Fauth0-config-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willhackett%2Fauth0-config-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willhackett%2Fauth0-config-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willhackett%2Fauth0-config-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/willhackett","download_url":"https://codeload.github.com/willhackett/auth0-config-deploy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/willhackett%2Fauth0-config-deploy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275013282,"owners_count":25390481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-13T02:00:10.085Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-09-13T18:51:16.975Z","updated_at":"2025-09-13T18:51:19.872Z","avatar_url":"https://github.com/willhackett.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# auth0-config-deploy\n\nConfigure, test \u0026amp; deploy Auth0 config via the Management API\n\n## Arguments\n\n### Usage\n\n| Argument                | Purpose                                                        |\n| ----------------------- | -------------------------------------------------------------- |\n| `--init`                | Creates the directory structure based on current tenant config |\n| `--deploy` (Alias `-d`) | Tests and deploys the current configuration                    |\n| `--test` (Alias `-t`)   | Tests the current configuration                                |\n| `--dry-run`             | Tests and provides verbose output of intended API calls        |\n\n### Configuration\n\nConfiguration can be passed in directly to the CLI or via environment variables. This is useful for\ndeploying via a pipeline.\n\n| Argument               | Default                   | Purpose                                                              |\n| ---------------------- | ------------------------- | -------------------------------------------------------------------- |\n| `--auth0-domain`       | `env.AUTH0_DOMAIN`        | Supplies the Auth0 Domain to use                                     |\n| `--auth0-clientId`     | `env.AUTH0_CLIENT_ID`     | Client ID to access Management API                                   |\n| `--auth0-clientSecret` | `env.AUTH0_CLIENT_SECRET` | Client Secret to access Management API                               |\n| `--base-dir`           | `/`                       | Specify the base dir for the tenant, useful for multi-tenant configs |\n\n## Providing Secrets to Config\n\nAn `env` object is provided to yaml via template strings, so to splat environment variables into your configuration\nyou can simple nest them within the configuration.\n\nFor example:\n\n```yaml\nsomeVariable: '{{ env.SOME_ENV_VAR }}\n```\n\nConditionals are also available, for documentation on this please refer to: XYZ LIBRARY HERE\n\n## YAML Anchors \u0026 Aliases\n\nTODO: Add a HOW TO with Anchors \u0026 Aliases\n\n## Additional Helpers\n\nThese helpers do not exist on the Management API but are provided here to make configuration simpler.\n\n### `enabled_realms` in Client Configurations\n\nThis option allows you to automatically populate the enabled `clientId` list on the connection instead of supplying the entire list via the `enabled_clients` option within connections config.\n\n### `use` for common configurations between tenants\n\nPlace `use.yaml` file in the directory containing a path to the common directory.\n\nThis applies to all configurations except for `clients/configs` as these are specific to the tenant.\n\nFor example:\n\n```yaml\npath: '/common/rules/'\n```\n\nPlacing this file at `rules/use.yaml` will prompt the CLI to use the rules within `/common/rules/`.\n\n### Excluding Liquid Syntax from a section of config\n\nAuth0 also allows liquid syntax within some fields, so if you intend to use this you can wrap it with `{{***}}` and `{{/***}}` to prevent syntax parsing.\n\n## Directory Structure\n\n```\nroot\n├── tenant.yaml\n├── guardian.yaml\n├── clients\n│   ├── configs\n│   │   └── {clientId}.yaml // A file exists per clientId\n│   └── common.yaml // Common store for client use with YAML Anchors \u0026 Aliases\n├── rules\n│   ├── __test__\n│   │   └── {rule}.test.js // Testing of the rules using a similar sandbox to Auth0\n│   ├── {rule}.js // Rule matching the environment configuration\n│   └── config.yaml // Rule ordering and environment configuration\n├── connections\n│   └── {realm}\n│       ├── config.yaml\n│       └── custom_database\n│           ├── __test__\n│           │   └── {script}.test.js\n│           └── {script}.js\n├── apis\n│   ├── configs\n│   │   └── {apiId}.yaml\n│   └── common.yaml // Common store for API use with YAML Anchors \u0026 Aliases\n├── email_templates\n    ├── {templateId}\n    │   ├── index.html // Email Template\n    │   └── config.yaml // Config for email template\n    └── common.yaml // Common store for email templates use with YAML Anchors \u0026 Aliases\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillhackett%2Fauth0-config-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwillhackett%2Fauth0-config-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwillhackett%2Fauth0-config-deploy/lists"}