Documentation spécifique aux ressources

Découvrez les spécificités de la documentation des ressources pour l’outil Auth0 Deploy CLI.

En règle générale, les fichiers de configuration des ressources de Deploy CLI correspondent étroitement aux schémas de charge utile de Management API Auth0, mais il existe quelques nuances notables à prendre en compte.

​

Autorisations des clients

L’autorisation d’accès au client de Deploy CLI n’est pas exportée ni configurable par elle-même. Cela permet d’éviter des modifications importantes, sinon l’outil pourrait potentiellement révoquer l’accès ou se planter au milieu d’une importation. Dans un contexte multilocataire et multi-environnement, on s’attend à ce que les nouveaux locataires aient un client désigné déjà établi pour l’outil Deploy CLI, comme mentionné dans la documentation Premiers pas.

​

Invites

Les invites textuelles multilingues personnalisées suivent une hiérarchie particulière. Sous la propriété de ressource des invites au niveau racine se trouve une propriété propriétaire customText qui est utilisée pour regrouper les traductions de texte personnalisées avec d’autres paramètres d’invites. Sous customText se trouve le code de langue à deux caractères. Le troisième est l’ID de l’invite, suivi de l’ID de l’écran, puis de l’ID du texte.

​

Hiérarchie

prompts:
  customText:
    <LANGUAGE>: # two character language code
      <PROMPT_ID>: # prompt ID
        <SCREEN_ID>: # prompt screen ID
          <TEXT_ID>: 'Some text'

​

Exemple

prompts:
  identifier_first: true
  universal_login_experience: classic
  customText:
    en:
      login:
        login:
          description: Login description in english
          buttonText: Button text
      mfa:
        mfa-detect-browser-capabilities:
          pickAuthenticatorText: 'Try another method'
          reloadButtonText: 'Reload'
          noJSErrorTitle: 'JavaScript Required'
        mfa-login-options:
          pageTitle: 'Log in to ${clientName}'
          authenticatorNamesSMS: 'SMS'

​

Bases de données

Lors de la gestion des connexions de base de données, les valeurs de options.customScripts pointent vers des fichiers javascript spécifiques relatifs au chemin du dossier de sortie. Sinon, la charge utile correspond étroitement à celle de Auth0 Management API.

​

Exemple YAML

Structure du dossier 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 du dossier 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"
    }
  }
}

​

Connexion universelle d’Auth0

​

Pages

Lorsque la connexion universelle est remplacée par un code HTML personnalisé, les contenus relatifs aux erreurs, à la connexion, à l’authentification multifacteur (MFA) et à la réinitialisation du mot de passe sont organisés dans des pages HTML spécifiques.

​

Exemple 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

Structure du dossier 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"
}