Documentation spécifique aux ressources

Découvrez les particularités de la documentation spécifique aux ressources pour l’Auth0 Deploy CLI.

En général, les fichiers de configuration des ressources de l’Auth0 Deploy CLI correspondent de près aux schémas de payload de l’Auth0 Management API, mais il y a quelques nuances importantes à connaître.

​

Autorisations client

L’autorisation client propre au Deploy CLI n’est volontairement ni exportée ni configurable de façon autonome. Cette mesure vise à éviter des changements incompatibles; autrement, l’outil pourrait révoquer l’accès ou même planter en pleine importation. Dans un contexte multitenant et multi-environnement, on s’attend à ce que les nouveaux tenants disposent déjà d’un client désigné pour le Deploy CLI, comme mentionné dans Getting Started.

​

Prompts

Les prompts de texte personnalisé multilingue suivent une hiérarchie particulière. Sous la propriété de ressource prompts de niveau supérieur se trouve une propriété customText exclusive, qui sert à regrouper les traductions de texte personnalisé avec d’autres paramètres de prompts. Sous customText se trouve le code de langue à deux caractères. Viennent ensuite l’ID de prompt, suivi de l’ID d’écran, puis de l’ID de texte.

​

Hiérarchie

prompts:
  customText:
    <LANGUAGE>: # code de langue à deux caractères
      <PROMPT_ID>: # ID du prompt
        <SCREEN_ID>: # ID de l'écran du prompt
          <TEXT_ID>: 'Some text'

​

Exemple

prompts:
  identifier_first: true
  universal_login_experience: classic
  customText:
    en:
      login:
        login:
          description: Description de connexion en anglais
          buttonText: Texte du bouton
      mfa:
        mfa-detect-browser-capabilities:
          pickAuthenticatorText: 'Essayer une autre méthode'
          reloadButtonText: 'Recharger'
          noJSErrorTitle: 'JavaScript requis'
        mfa-login-options:
          pageTitle: 'Se connecter à ${clientName}'
          authenticatorNamesSMS: 'SMS'

​

Bases de données

Lors de la gestion des connexions de base de données, les valeurs de options.customScripts renvoient à des fichiers Javascript précis dont le chemin est relatif au dossier de sortie. Sinon, le payload correspond de près à celui de l’Auth0 Management API.

​

Exemple en YAML

Structure des dossiers en mode YAML :

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

 Contenu de 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

​

Exemple de répertoire

Structure des dossiers en mode répertoire :

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

Contenu 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

​

Pages

Lorsque vous remplacez le Universal Login par du HTML personnalisé, le contenu des pages d’erreur, de connexion, d’authentification multifacteur et de réinitialisation du mot de passe est réparti dans des pages HTML distinctes.

​

Exemple en YAML

Structure du dossier en mode YAML :

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

Contenu 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

​

Exemple de répertoire

Arborescence des dossiers en mode répertoire :

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

Contenu de login.json :

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

Contenu de error_page.json :

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

Contenu de guardian_multifactor.json :

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

Contenu de password_reset.json :

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