Documentación específica de cada recurso

Obtenga información sobre las particularidades de la documentación de recursos para Auth0 Deploy CLI.

En general, los archivos de configuración de recursos de Deploy CLI se ajustan estrechamente a los esquemas de payload de Auth0 Management API, pero hay algunos matices importantes que debe tener en cuenta.

​

Concesiones de cliente

La concesión de cliente propia de Deploy CLI no se exporta intencionadamente ni puede configurarse de forma independiente. Esto se hace para evitar cambios incompatibles; de lo contrario, la herramienta podría revocar el acceso o bloquearse en mitad de una importación. En un contexto con varios inquilinos y varios entornos, se espera que los inquilinos nuevos ya tengan un cliente designado para Deploy CLI, como se menciona en Primeros pasos.

​

Pantallas

Las pantallas de texto personalizado multilingüe siguen una jerarquía específica. En la propiedad de recurso prompts del nivel raíz hay una propiedad propietaria customText que se utiliza para agrupar las traducciones de texto personalizado con otras configuraciones de las pantallas. Debajo de customText está el código de idioma de dos caracteres. En tercer lugar está el ID de la pantalla, seguido del ID de la pantalla, seguido del ID del texto.

​

Jerarquía

prompts:
  customText:
    <LANGUAGE>: # código de idioma de dos caracteres
      <PROMPT_ID>: # ID de pantalla
        <SCREEN_ID>: # ID de pantalla de la pantalla
          <TEXT_ID>: 'Some text'

​

Ejemplo

prompts:
  identifier_first: true
  universal_login_experience: classic
  customText:
    en:
      login:
        login:
          description: Descripción de inicio de sesión en inglés
          buttonText: Texto del botón
      mfa:
        mfa-detect-browser-capabilities:
          pickAuthenticatorText: 'Probar otro método'
          reloadButtonText: 'Recargar'
          noJSErrorTitle: 'JavaScript requerido'
        mfa-login-options:
          pageTitle: 'Iniciar sesión en ${clientName}'
          authenticatorNamesSMS: 'SMS'

​

Bases de datos

Al administrar conexiones de bases de datos, los valores de options.customScripts apuntan a archivos JavaScript específicos con rutas relativas a la carpeta de salida. En lo demás, el payload coincide en gran medida con el de la Auth0 Management API.

​

Ejemplo de YAML

Estructura de carpetas en el modo YAML:

./databases/
    /Username-Password-Authentication
        /change_password.js   
        /create.js   
        /delete.js   
        /get_user.js   
        /login.js   
        /verify.js   
./tenant.yaml

 Contenido del archivo tenant.yaml:

databases:
  - name: Username-Password-Authentication
    # ...
    options:
      # ...
      customScripts:
        change_password: ./databases/Username-Password-Authentication/change_password.js
        create: ./databases/Username-Password-Authentication/create.js
        delete: ./databases/Username-Password-Authentication/delete.js
        get_user: ./databases/Username-Password-Authentication/get_user.js
        login: ./databases/Username-Password-Authentication/login.js
        verify: ./databases/Username-Password-Authentication/verify.js

​

Ejemplo de directorio

Estructura de carpetas en modo directorio:

./database-connections/
    ./Username-Password-Authentication/
        ./change_password.js
        ./create.js
        ./database.json
        ./delete.js
        ./get_user.js
        ./login.js
        ./verify.js

Contenido de database.json:

{
  "options": {
    "customScripts": {
      "change_password": "./change_password.js",
      "create": "./create.js",
      "delete": "./delete.js",
      "get_user": "./get_user.js",
      "login": "./login.js",
      "verify": "./verify.js"
    }
  }
}

​

Universal Login

​

Páginas

Al sobrescribir el Universal Login con HTML personalizado, el contenido de error, inicio de sesión, autenticación multifactor y restablecimiento de contraseña se organiza en páginas HTML específicas.

​

Ejemplo de YAML

Estructura de carpetas en el modo YAML:

./pages/
    /error_page.html
    /guardian_multifactor.html
    /login.html
    /password_reset.html
./tenant.yaml

Contenido de tenant.yaml:

pages:
  - name: error_page
    html: ./pages/error_page.html
    show_log_link: false
    url: https://mycompany.org/error
  - name: guardian_multifactor
    enabled: true
    html: ./pages/guardian_multifactor.html
  - name: login
    enabled: false
    html: ./pages/login.html
  - name: password_reset
    enabled: true
    html: ./pages/password_reset.html

​

Ejemplo de directorio

Estructura de carpetas en el modo de directorio:

./pages/
    ./error_page.html
    ./error_page.json
    ./guardian_multifactor.html
    ./guardian_multifactor.json
    ./login.html
    ./login.json
    ./password_reset.html
    ./password_reset.json

Contenido de login.json:

{
  "name": "login",
  "enabled": false,
  "html": "./login.html"
}

Contenido de error_page.json:

{
  "html": "./error_page.html",
  "show_log_link": false,
  "url": "https://mycompany.org/error",
  "name": "error_page"
}

Contenido de guardian_multifactor.json:

{
  "enabled": true,
  "html": "./guardian_multifactor.html",
  "name": "guardian_multifactor"
}

Contenido de password_reset.json:

{
  "enabled": true,
  "html": "./password_reset.html",
  "name": "password_reset"
}