Configurar Deploy CLI

Aprenda a configurar Auth0 Deploy CLI para adaptar la herramienta a sus necesidades.

Configurar Deploy CLI es fundamental para establecer las credenciales de Auth0 y, en general, adaptar el comportamiento de la herramienta a sus necesidades específicas. Hay dos formas de configurar Deploy CLI:

1. Usar el archivo de configuración (config.json).
2. Establecer variables de entorno.

​

Archivo de configuración

Puede usar un archivo JSON independiente para configurar Deploy CLI. Normalmente, este archivo se encuentra en el directorio raíz de su proyecto y debe llamarse config.json.

​

Ejemplo

{
  "AUTH0_DOMAIN": "<YOUR_TENANT_DOMAIN>",
  "AUTH0_CLIENT_ID": "{yourClientId}",
  "AUTH0_ALLOW_DELETE": false
}

No se recomienda incluir credenciales de forma fija en el código, ya que existe el riesgo de que los secretos se filtren si este archivo llega a confirmarse en un sistema público de control de versiones. Para mitigar este riesgo, como práctica recomendada, pase las credenciales como variables de entorno.

​

Variables de entorno

De forma predeterminada, Deploy CLI lee las variables de entorno, lo que permite pasar credenciales y otras opciones de configuración a la herramienta sin necesidad de publicarlas en el archivo config.json. Las variables de entorno pueden usarse para complementar el archivo config.json o sustituirlo por completo, según las necesidades del proyecto.

Los valores de configuración no primitivos, como AUTH0_KEYWORD_REPLACE_MAPPINGS y AUTH0_EXCLUDED, también pueden pasarse mediante variables de entorno, siempre que estén correctamente serializados como JSON.

Para deshabilitar el uso de variables de entorno en los comandos import o export, pase el argumento --env=false.

​

Ejemplos

​

Despliegue de la configuración para formatos YAML sin un archivo config.json

$ export AUTH0_DOMAIN={yourDomain}
$ export AUTH0_CLIENT_ID={yourClientId}
$ export AUTH0_CLIENT_SECRET={yourClientSecret}
$ a0deploy import --input_file=local/tenant.yaml

​

Deshabilitar la carga de variables de entorno

$ a0deploy export -c=config.json --format=yaml --output_folder=local --env=false

​

Valores de configuración no primitivos

$ export AUTH0_EXCLUDED='["actions","organizations"]'
$ export AUTH0_KEYWORD_REPLACE_MAPPINGS='{"ENVIRONMENT":"dev"}'
$ a0deploy export -c=config.json --format=yaml --output_folder=local

​

Propiedades de configuración disponibles

​

AUTH0_DOMAIN

Cadena. El dominio del inquilino de destino de Auth0.

​

AUTH0_CLIENT_ID

Cadena. El id de la aplicación de Auth0 especificada que se usa para realizar solicitudes a la API.

​

AUTH0_CLIENT_SECRET

Cadena. El secreto de la aplicación de Auth0 especificada que se usa para realizar solicitudes a la API.

​

AUTH0_ACCESS_TOKEN

Cadena. token de acceso de corta duración para Management API de la aplicación de Auth0 especificada. Se puede usar en lugar de la combinación de ID de cliente y Secreto del cliente.

​

AUTH0_CLIENT_SIGNING_KEY_PATH

Cadena. La ruta de acceso a la clave privada que utiliza el cliente para la autenticación con Private Key JWT. Ruta relativa al directorio de trabajo. Consulte también AUTH0_CLIENT_SIGNING_ALGORITHM para especificar el algoritmo de firma.

​

AUTH0_CLIENT_SIGNING_ALGORITHM

Cadena. Especifica los algoritmos de firma de JWT que usa el cliente al llevar a cabo la autenticación con Private Key JWT. Solo se usa en combinación con AUTH0_CLIENT_SIGNING_KEY_PATH.

Valores aceptados: RS256, RS384, PS256.

​

AUTH0_ALLOW_DELETE

Booleano. Cuando está habilitado, permite que la herramienta elimine recursos. Predeterminado: false.

​

AUTH0_EXCLUDED

Array de cadenas. Excluye tipos de recursos completos de ser administrados bidireccionalmente. Para obtener más información, consulte Excluir recursos de la administración.

No puede usarse simultáneamente con AUTH0_INCLUDED_ONLY.

Valores posibles: actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers.

​

Ejemplo

{
  "AUTH0_EXCLUDED": ["organizations", "connections", "hooks"]
}

​

AUTH0_INCLUDED_ONLY

Array de cadenas. Especifica qué tipos de recursos se gestionarán de forma bidireccional. Para obtener más información, consulte excluir recursos de la administración.

No puede usarse simultáneamente con AUTH0_EXCLUDED.

Valores posibles: actions, attackProtection, branding, clientGrants, clients, connections, customDomains, databases, emailProvider, emailTemplates, guardianFactorProviders, guardianFactorTemplates, guardianFactors, guardianPhoneFactorMessageTypes, guardianPhoneFactorSelectedProvider, guardianPolicies, logStreams, migrations, organizations, pages, prompts, resourceServers, roles, tenant, triggers.

​

Ejemplo

{
  "AUTH0_INCLUDED_ONLY": ["clients", "connections", "tenant", "branding"]
}

​

AUTH0_KEYWORD_REPLACE_MAPPINGS

Asignación de palabras clave específicas para facilitar su reemplazo dinámico. Para obtener más información, consulte Reemplazo de palabras clave.

​

Ejemplo

{
  "ENVIRONMENT": "DEV",
  "ALLOWED_ORIGINS": ["https://dev.test-site.com", "localhost"]
}

​

AUTH0_PRESERVE_KEYWORDS

Booleano. Cuando está habilitado, intentará conservar los marcadores de sustitución de palabras clave en los archivos de recursos locales durante la exportación. De lo contrario, los valores remotos sobrescribirán esos marcadores de palabras clave colocados manualmente.

Esta configuración requiere la presencia de archivos de configuración locales y asignaciones de sustitución de palabras clave definidas mediante la propiedad de configuración AUTH0_KEYWORD_REPLACE_MAPPINGS.

Consulte también: Conservar palabras clave en la exportación.

​

AUTH0_EXPORT_IDENTIFIERS

Booleano. Cuando está habilitado, devuelve los identificadores de todos los recursos. Puede resultar útil en determinados escenarios de depuración o mantenimiento de registros dentro de un contexto de inquilino único. Valor predeterminado: false.

​

EXCLUDED_PROPS

Permite excluir de la administración cualquier propiedad no deseada.

​

Ejemplo

{
  "connections": ["options.twilio_token"]
}

​

AUTH0_AUDIENCE

Cadena. Valor independiente del valor de audiencia al recuperar un token de acceso para la Management API. Resulta útil cuando los endpoints predeterminados de la Management API no están expuestos públicamente.

​

AUTH0_EXCLUDED_RULES

Array de cadenas. Excluye la gestión de Rules específicas por id. Nota: Esta configuración puede quedar obsoleta en el futuro. Para obtener más información, consulte Excluir recursos de la administración.

​

AUTH0_EXCLUDED_CLIENTS

Array de cadenas. Excluye de la administración clientes específicos por ID. Nota: Esta configuración podría quedar obsoleta en el futuro. Para obtener más información, consulte Excluir recursos de la administración.

​

AUTH0_EXCLUDED_DATABASES

Array de cadenas. Excluye la administración de bases de datos específicas por ID. Nota: Esta configuración podría quedar obsoleta en el futuro. Para obtener más información, consulte Excluir recursos de la administración.

​

AUTH0_EXCLUDED_CONNECTIONS

Array de cadenas. Excluye la administración de conexiones específicas por ID. Nota: Esta configuración podría quedar obsoleta en el futuro. Para obtener más información, consulte Excluir recursos de la administración.

​

AUTH0_EXCLUDED_RESOURCE_SERVERS

Array de cadenas. Excluye la administración de servidores de recursos específicos por ID. Nota: esta configuración puede quedar obsoleta en el futuro. Para obtener más información, consulte Excluir recursos de la administración.